Analyse Jira expression

POST

/rest/api/3/expression/analyse

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.

Request Example

Shell

JavaScript

Java

Swift

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'\''])"
    ]
}'

Response Example

200 - Success

{"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

Body Params application/json

Examples

Responses

🟢200Returned if the request is successful.

application/json

Body

🟠400400 response

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

🟠404404 response

Modified at 2023-07-13 03:27:27

Transition issue

Evaluate Jira expression