Check issues against JQL

POST

/rest/api/3/jql/match

Checks whether one or more issues would be returned by one or more JQL queries.

Permissions required: None, however, issues are only matched against JQL queries where the user has:

Browse projects project permission for the project that the issue is in.

If issue-level security is configured, issue-level security permission to view the issue.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/jql/match' \
--header 'Content-Type: application/json' \
--data-raw '{
    "issueIds": [
        10001,
        1000,
        10042
    ],
    "jqls": [
        "project = FOO",
        "issuetype = Bug",
        "summary ~ \"some text\" AND project in (FOO, BAR)"
    ]
}'

Response Example

200 - Success

{"matches":[{"matchedIssues":[10000,10004],"errors":[]},{"matchedIssues":[100134,10025,10236],"errors":[]},{"matchedIssues":[],"errors":[]},{"matchedIssues":[],"errors":["Invalid JQL: broken = value"]}]}

Request

Body Params application/json

List of issues and JQL queries.

issueIds

array[integer <int64>]

required

A list of issue IDs.

jqls

array[string]

required

A list of JQL queries.

Examples

Responses

🟢200Returned if the request is successful.

application/json

Body

A list of matched issues or errors for each JQL query, in the order the JQL queries were passed.

matches

array[object (IssueMatchesForJQL) {2}]

required

errors

array[string]

required

A list of errors.

matchedIssues

array[integer <int64>]

required

A list of issue IDs.

🟠400Returned if `jqls` exceeds the maximum number of JQL queries or `issueIds` exceeds the maximum number of issue IDs.

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

Get issue picker suggestions

Search for issues using JQL (GET)