Analyse Jira expression

Analyses and validates Jira expressions.

As an experimental feature, this operation can also attempt to type-check the expressions.

Learn more about Jira expressions in the documentation.

Permissions required: None.

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/expression/analyse' \ --header 'Content-Type: application/json' \ --data-raw '{ "contextVariables": { "listOfStrings": "List<String>", "record": "{ a: Number, b: String }", "value": "User" }, "expressions": [ "issues.map(issue => issue.properties['\''property_key'\''])" ] }'

{"results":[{"expression":"analysed expression","errors":[{"line":1,"column":4,"message":"!, -, typeof, (, IDENTIFIER, null, true, false, NUMBER, STRING, TEMPLATE_LITERAL, new, [ or { expected, > encountered.","type":"syntax"},{"message":"Jira expression is too long (1040), limit: 1000 characters","type":"other"},{"message":"Jira expression has too many nodes (150), limit: 100 leaves","type":"other"}],"valid":false},{"expression":"issues.map(i => {idAndKey: [i.id, i.key], summary: i.summary, comments: i.comments})","valid":true,"type":"List<{idAndKey: [Number, String], summary: String, comments: List<Comment>}>","complexity":{"expensiveOperations":"N","variables":{"N":"issues"}}},{"expression":"issues.map(i => i.id > '0')","errors":[{"expression":"i.id > 0","message":"Can't compare Number to String.","type":"type"}],"valid":false,"type":"TypeError"}]}

Request

Query Params

check

string

optional

The check to perform:

syntax Each expression's syntax is checked to ensure the expression can be parsed. Also, syntactic limits are validated. For example, the expression's length.

type EXPERIMENTAL. Each expression is type checked and the final type of the expression inferred. Any type errors that would result in the expression failure at runtime are reported. For example, accessing properties that don't exist or passing the wrong number of arguments to functions. Also performs the syntax check.

complexity EXPERIMENTAL. Determines the formulae for how many expensive operations each expression may execute.

Body Params application/json

Details of Jira expressions for analysis.

contextVariables

object

optional

Context variables and their types. The type checker assumes that common context variables, such as issue or project, are available in context and sets their type. Use this property to override the default types or provide details of new variables.

Additional properties

string

optional

expressions

array[string]

required

The list of Jira expressions to analyse.

Example:

issues.map(issue => issue.properties['property_key'])

Examples

Responses

🟢200Returned if the request is successful.

application/json

Body

Details about the analysed Jira expression.

results

array[object (JiraExpressionAnalysis) {5}]

required

The results of Jira expressions analysis.

complexity

object (JiraExpressionComplexity)

optional

Details about the complexity of the analysed Jira expression.

errors

array[object (JiraExpressionValidationError) {5}]

optional

A list of validation errors. Not included if the expression is valid.

expression

string

required

The analysed expression.

type

string

optional

EXPERIMENTAL. The inferred type of the expression.

valid

boolean

required

Whether the expression is valid and the interpreter will evaluate it. Note that the expression may fail at runtime (for example, if it executes too many expensive operations).

🟠400400 response

🟠401Returned if the authentication credentials are incorrect or missing.

🟠404404 response