Atlassian · Schema

SearchResults

The result of a JQL search.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name	Type	Description
expand	string	Expand options that include additional search result details in the response.
issues	array	The list of issues found by the search.
maxResults	integer	The maximum number of results that could be on the page.
names	object	The ID and name of each field in the search results.
schema	object	The schema describing the field types in the search results.
startAt	integer	The index of the first item returned on the page.
total	integer	The number of results on the page.
warningMessages	array	Any warnings related to the JQL query.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SearchResults",
  "title": "SearchResults",
  "additionalProperties": false,
  "description": "The result of a JQL search.",
  "properties": {
    "expand": {
      "description": "Expand options that include additional search result details in the response.",
      "readOnly": true,
      "type": "string"
    },
    "issues": {
      "description": "The list of issues found by the search.",
      "items": {
        "$ref": "#/components/schemas/IssueBean"
      },
      "readOnly": true,
      "type": "array"
    },
    "maxResults": {
      "description": "The maximum number of results that could be on the page.",
      "format": "int32",
      "readOnly": true,
      "type": "integer"
    },
    "names": {
      "additionalProperties": {
        "readOnly": true,
        "type": "string"
      },
      "description": "The ID and name of each field in the search results.",
      "readOnly": true,
      "type": "object"
    },
    "schema": {
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonTypeBean"
      },
      "description": "The schema describing the field types in the search results.",
      "readOnly": true,
      "type": "object"
    },
    "startAt": {
      "description": "The index of the first item returned on the page.",
      "format": "int32",
      "readOnly": true,
      "type": "integer"
    },
    "total": {
      "description": "The number of results on the page.",
      "format": "int32",
      "readOnly": true,
      "type": "integer"
    },
    "warningMessages": {
      "description": "Any warnings related to the JQL query.",
      "items": {
        "readOnly": true,
        "type": "string"
      },
      "readOnly": true,
      "type": "array"
    }
  },
  "type": "object"
}