POST /rest/api/2/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.

Servers

https://your-domain.atlassian.net

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Query parameters

Name Type Required Description

Name	Type	Required	Description
`check`	String	No	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. Possible values: `"type"` `"complexity"` `"syntax"` Default value: "syntax"

check

String

No

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.

Possible values:

"type"
"complexity"
"syntax"

Default value: "syntax"

Request body fields

Name	Type	Required	Description
`expressions[]`	Array	Yes	The list of Jira expressions to analyse.
`contextVariables`	Object	No	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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.

All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.

Pricing Templates Integrations Blog Contact Us Help

Terms of Service Privacy Policy