Jira · Schema

SearchRequest

Request body for JQL search via POST.

AgileIssue TrackingITSMProject ManagementService Management

Properties

Name Type Description
jql string The JQL query string.
startAt integer The index of the first item to return (page offset).
maxResults integer The maximum number of items to return per page.
validateQuery string Whether to validate the JQL query. Accepted values: strict, warn, none.
fields array Fields to return for each issue.
expand string Expand options for additional information.
properties array Issue properties to return.
fieldsByKeys boolean Whether to reference fields by keys rather than IDs.
View JSON Schema on GitHub

JSON Schema

jira-cloud-platform-rest-search-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "SearchRequest",
  "type": "object",
  "description": "Request body for JQL search via POST.",
  "properties": {
    "jql": {
      "type": "string",
      "description": "The JQL query string."
    },
    "startAt": {
      "type": "integer",
      "description": "The index of the first item to return (page offset)."
    },
    "maxResults": {
      "type": "integer",
      "description": "The maximum number of items to return per page."
    },
    "validateQuery": {
      "type": "string",
      "description": "Whether to validate the JQL query. Accepted values: strict, warn, none."
    },
    "fields": {
      "type": "array",
      "description": "Fields to return for each issue."
    },
    "expand": {
      "type": "string",
      "description": "Expand options for additional information."
    },
    "properties": {
      "type": "array",
      "description": "Issue properties to return."
    },
    "fieldsByKeys": {
      "type": "boolean",
      "description": "Whether to reference fields by keys rather than IDs."
    }
  }
}