Evaluate Jira expression

POST

/rest/api/3/expression/eval

Jira expressions

Evaluates a Jira expression and returns its value.

This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible way. Consult the Jira expressions documentation for more details.

Context variables

The following context variables are available to Jira expressions evaluated by this resource. Their presence depends on various factors; usually you need to manually request them in the context object sent in the payload, but some of them are added automatically under certain conditions.

user (User): The current user. Always available and equal to null if the request is anonymous.

app (App): The Connect app that made the request. Available only for authenticated requests made by Connect Apps (read more here: Authentication for Connect apps).

issue (Issue): The current issue. Available only when the issue is provided in the request context object.

issues (List of Issues): A collection of issues matching a JQL query. Available only when JQL is provided in the request context object.

project (Project): The current project. Available only when the project is provided in the request context object.

sprint (Sprint): The current sprint. Available only when the sprint is provided in the request context object.

board (Board): The current board. Available only when the board is provided in the request context object.

serviceDesk (ServiceDesk): The current service desk. Available only when the service desk is provided in the request context object.

customerRequest (CustomerRequest): The current customer request. Available only when the customer request is provided in the request context object.

Also, custom context variables can be passed in the request with their types. Those variables can be accessed by key in the Jira expression. These variable types are available for use in a custom context:

user: A user specified as an Atlassian account ID.

issue: An issue specified by ID or key. All the fields of the issue object are available in the Jira expression.

json: A JSON object containing custom content.

list: A JSON list of user, issue, or json variable types.

This operation can be accessed anonymously.

Permissions required: None. However, an expression may return different results for different users depending on their permissions. For example, different users may see different comments on the same issue.
Permission to access Jira Software is required to access Jira Software context variables (board and sprint) or fields (for example, issue.sprint).

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/expression/eval' \
--header 'Content-Type: application/json' \
--data-raw '{
    "context": {
        "board": 10100,
        "custom": {
            "config": {
                "type": "json",
                "value": {
                    "userId": "10002"
                }
            },
            "issuesList": [
                {
                    "key": "ACJIRA-1471",
                    "type": "issue"
                },
                {
                    "id": 100001,
                    "type": "issue"
                }
            ],
            "myUser": {
                "accountId": "100001",
                "type": "user"
            },
            "nullField": {
                "type": "json"
            }
        },
        "customerRequest": 1450,
        "issue": {
            "key": "ACJIRA-1470"
        },
        "issues": {
            "jql": {
                "maxResults": 100,
                "query": "project = HSP",
                "startAt": 0,
                "validation": "strict"
            }
        },
        "project": {
            "key": "ACJIRA"
        },
        "serviceDesk": 10023,
        "sprint": 10001
    },
    "expression": "{ key: issue.key, type: issue.issueType.name, links: issue.links.map(link => link.linkedIssue.id), listCustomVariable: issuesList.includes(issue), customVariables: myUser.accountId == config.userId}"
}'

Response Example

200 - Success

{
  "value": "The expression's result. This value can be any JSON, not necessarily a String",
  "meta": {
    "complexity": {
      "steps": {
        "value": 1,
        "limit": 10000
      },
      "expensiveOperations": {
        "value": 3,
        "limit": 10
      },
      "beans": {
        "value": 0,
        "limit": 1000
      },
      "primitiveValues": {
        "value": 1,
        "limit": 10000
      }
    },
    "issues": {
      "jql": {
        "startAt": 0,
        "maxResults": 1000,
        "count": 140,
        "totalCount": 140,
        "validationWarnings": [
          "There is a problem with the JQL query."
        ]
      }
    }
  }
}

Request

Query Params

expand

string

optional

Use expand to include additional information in the response. This parameter accepts meta.complexity that returns information about the expression complexity. For example, the number of expensive operations used by the expression and how close the expression is to reaching the complexity limit. Useful when designing and debugging your expressions.

Body Params application/json

context

object

optional

The context in which the Jira expression is evaluated.

board

integer <int64>

optional

The ID of the board that is available under the board variable when evaluating the expression.

custom

array[null (CustomContextVariable) {3}]

optional

Custom context variables and their types. These variable types are available for use in a custom context:

user: A user specified as an Atlassian account ID.

issue: An issue specified by ID or key. All the fields of the issue object are available in the Jira expression.

json: A JSON object containing custom content.

list: A JSON list of user, issue, or json variable types.

customerRequest

integer <int64>

optional

The ID of the customer request that is available under the customerRequest variable when evaluating the expression. This is the same as the ID of the underlying Jira issue, but the customer request context variable will have a different type.

issue

object

optional

The issue that is available under the issue variable when evaluating the expression.

issues

object

optional

The collection of issues that is available under the issues variable when evaluating the expression.

project

object

optional

The project that is available under the project variable when evaluating the expression.

serviceDesk

integer <int64>

optional

The ID of the service desk that is available under the serviceDesk variable when evaluating the expression.

sprint

integer <int64>

optional

The ID of the sprint that is available under the sprint variable when evaluating the expression.

expression

string

required

The Jira expression to evaluate.

Example:

{ key: issue.key, type: issue.issueType.name, links: issue.links.map(link => link.linkedIssue.id) }

Examples

Responses

🟢200Returned if the evaluation results in a value. The result is a JSON primitive value, list, or object.

application/json

Body

The result of evaluating a Jira expression.

Evaluate Jira expression

Context variables#

Request

Responses

Context variables