Atlassian · Schema

JexpJqlIssues

The JQL specifying the issues available in the evaluated Jira expression under the `issues` context variable. Not all issues returned by the JQL query are loaded, only those described by the `startAt` and `maxResults` properties. To determine whether it is necessary to iterate to ensure all the issues returned by the JQL query are evaluated, inspect `meta.issues.jql.count` in the response.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name	Type	Description
maxResults	integer	The maximum number of issues to return from the JQL query. Inspect `meta.issues.jql.maxResults` in the response to ensure the maximum value has not been exceeded.
query	string	The JQL query.
startAt	integer	The index of the first issue to return from the JQL query.
validation	string	Determines how to validate the JQL query and treat the validation results.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/JexpJqlIssues",
  "title": "JexpJqlIssues",
  "additionalProperties": false,
  "description": "The JQL specifying the issues available in the evaluated Jira expression under the `issues` context variable. Not all issues returned by the JQL query are loaded, only those described by the `startAt` and `maxResults` properties. To determine whether it is necessary to iterate to ensure all the issues returned by the JQL query are evaluated, inspect `meta.issues.jql.count` in the response.",
  "properties": {
    "maxResults": {
      "description": "The maximum number of issues to return from the JQL query. Inspect `meta.issues.jql.maxResults` in the response to ensure the maximum value has not been exceeded.",
      "format": "int32",
      "type": "integer"
    },
    "query": {
      "description": "The JQL query.",
      "type": "string"
    },
    "startAt": {
      "description": "The index of the first issue to return from the JQL query.",
      "format": "int64",
      "type": "integer"
    },
    "validation": {
      "default": "strict",
      "description": "Determines how to validate the JQL query and treat the validation results.",
      "enum": [
        "strict",
        "warn",
        "none"
      ],
      "type": "string"
    }
  },
  "type": "object"
}