Atlassian: Issue search schemas

14 Atlassian schemas with complete fields and constraints.

Check issues against JQL — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	List of issues and JQL queries. Additional keys: not allowed
`issueIds`	array	Required within parent	A list of up to 50 issue IDs. Unique items: true
`issueIds[]`	integer	Each item	A list of up to 50 issue IDs. Format: int64
`jqls`	array	Required within parent	A list of up to 10 JQL queries.
`jqls[]`	string	Each item	A list of up to 10 JQL queries.

Check issues against JQL — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A list of matched issues or errors for each JQL query, in the order the JQL queries were passed.
`matches`	JSON	Optional
`matches (anyOf 1)`	array	Alternative
`matches (anyOf 1)[]`	Model	Each item	Expand Check issues against JQL — response body — matches array item
`matches (anyOf 2)`	null	Alternative

Referenced models: Check issues against JQL — response body — matches array item

Check issues against JQL — response body — matches array item

Field	Type	Presence	Description and constraints
`$`	object	Root	A list of the issues matched to a JQL query or details of errors encountered during matching.
`errors`	JSON	Optional
`errors (anyOf 1)`	array	Alternative	A list of errors. Unique items: true
`errors (anyOf 1)[]`	string	Each item	A list of errors.
`errors (anyOf 2)`	null	Alternative
`matchedIssues`	JSON	Optional
`matchedIssues (anyOf 1)`	array	Alternative	A list of issue IDs. Unique items: true
`matchedIssues (anyOf 1)[]`	JSON	Each item
`matchedIssues (anyOf 1)[] (anyOf 1)`	integer	Alternative	A list of issue IDs. Format: int64
`matchedIssues (anyOf 1)[] (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`matchedIssues (anyOf 2)`	null	Alternative

Count issues using JQL — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`jql`	string	Optional	A [JQL](https://confluence.atlassian.com/x/egORLQ) expression. For performance reasons, this parameter requires a bounded query. A bounded query is a query with a search restriction.

Count issues using JQL — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`count`	JSON	Optional
`count (anyOf 1)`	JSON	Alternative
`count (anyOf 1) (anyOf 1)`	integer	Alternative	Number of issues matching JQL query. Format: int64
`count (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`count (anyOf 2)`	null	Alternative

Currently being removed Search for issues using JQL (GET) — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	The result of a JQL search.
`expand`	JSON	Optional
`expand (anyOf 1)`	string	Alternative	Expand options that include additional search result details in the response. Read only: true
`expand (anyOf 2)`	null	Alternative
`issues`	JSON	Optional
`issues (anyOf 1)`	array	Alternative	The list of issues found by the search. Read only: true
`issues (anyOf 1)[]`	Model	Each item	Expand Get issue — response body
`issues (anyOf 2)`	null	Alternative
`maxResults`	JSON	Optional
`maxResults (anyOf 1)`	JSON	Alternative
`maxResults (anyOf 1) (anyOf 1)`	integer	Alternative	The maximum number of results that could be on the page. Format: int32 Read only: true
`maxResults (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`maxResults (anyOf 2)`	null	Alternative
`names`	JSON	Optional
`names (anyOf 1)`	object	Alternative	The ID and name of each field in the search results. Read only: true Additional keys: see wildcard field
`names (anyOf 1).*`	string	Additional keys	Read only: true
`names (anyOf 2)`	null	Alternative
`schema`	JSON	Optional
`schema (anyOf 1)`	object	Alternative	The schema describing the field types in the search results. Read only: true Additional keys: see wildcard field
`schema (anyOf 1).*`	Model	Additional keys	Expand Create custom field — response body — schema The schema of a field
`schema (anyOf 2)`	null	Alternative
`startAt`	JSON	Optional
`startAt (anyOf 1)`	JSON	Alternative
`startAt (anyOf 1) (anyOf 1)`	integer	Alternative	The index of the first item returned on the page. Format: int32 Read only: true
`startAt (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`startAt (anyOf 2)`	null	Alternative
`total`	JSON	Optional
`total (anyOf 1)`	JSON	Alternative
`total (anyOf 1) (anyOf 1)`	integer	Alternative	The number of results on the page. Format: int32 Read only: true
`total (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`total (anyOf 2)`	null	Alternative
`warningMessages`	JSON	Optional
`warningMessages (anyOf 1)`	array	Alternative	Any warnings related to the JQL query. Read only: true
`warningMessages (anyOf 1)[]`	string	Each item	Read only: true
`warningMessages (anyOf 2)`	null	Alternative

Referenced models: Get issue — response body, Create custom field — response body — schema The schema of a field

Currently being removed Search for issues using JQL (POST) — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`expand`	array	Optional	Use [expand](#expansion) to include additional information about issues in the response. Note that, unlike the majority of instances where `expand` is specified, `expand` is defined as a list of values. The expand options are: * `renderedFields` Returns field values rendered in HTML format. * `names` Returns the display name of each field. * `schema` Returns the schema describing a field type. * `transitions` Returns all possible transitions for the issue. * `operations` Returns all possible operations for the issue. * `editmeta` Returns information about how each field can be edited. * `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent. * `versionedRepresentations` Instead of `fields`, returns `versionedRepresentations` a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version.
`expand[]`	string	Each item
`fields`	array	Optional	A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include: * `all` Returns all fields. `navigable` Returns navigable fields. Any issue field, prefixed with a minus to exclude. The default is `navigable`. Examples: `summary,comment` Returns the summary and comments fields only. * `-description` Returns all navigable (default) fields except description. * `*all,-comment` Returns all fields except comments. Multiple `fields` parameters can be included in a request. Note: All navigable fields are returned by default. This differs from [GET issue](#api-rest-api-3-issue-issueIdOrKey-get) where the default is all fields.
`fields[]`	string	Each item
`fieldsByKeys`	boolean	Optional	Reference fields by their key (rather than ID). The default is `false`.
`jql`	string	Optional	A [JQL](https://confluence.atlassian.com/x/egORLQ) expression.
`maxResults`	integer	Optional	The maximum number of items to return per page. Default: 50 Format: int32
`properties`	array	Optional	A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list.
`properties[]`	string	Each item
`startAt`	integer	Optional	The index of the first item to return in the page of results (page offset). The base index is `0`. Format: int32
`validateQuery`	string	Optional	Determines how to validate the JQL query and treat the validation results. Supported values: * `strict` Returns a 400 response code if any errors are found, along with a list of all errors (and warnings). * `warn` Returns all errors as warnings. * `none` No validation is performed. * `true` Deprecated A legacy synonym for `strict`. * `false` Deprecated A legacy synonym for `warn`. The default is `strict`. Note: If the JQL is not correctly formed a 400 response code is returned, regardless of the `validateQuery` value. One of: strict, warn, none, true, false

Get issue picker suggestions — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A list of issues suggested for use in auto-completion.
`sections`	JSON	Optional
`sections (anyOf 1)`	array	Alternative	A list of issues for an issue type suggested for use in auto-completion. Read only: true
`sections (anyOf 1)[]`	Model	Each item	Expand Get issue picker suggestions — response body — sections array item
`sections (anyOf 2)`	null	Alternative

Referenced models: Get issue picker suggestions — response body — sections array item

Get issue picker suggestions — response body — sections array item

Field	Type	Presence	Description and constraints
`$`	object	Root	A type of issue suggested for use in auto-completion.
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the type of issues suggested for use in auto-completion. Read only: true
`id (anyOf 2)`	null	Alternative
`issues`	JSON	Optional
`issues (anyOf 1)`	array	Alternative	A list of issues suggested for use in auto-completion. Read only: true
`issues (anyOf 1)[]`	Model	Each item	Expand Get issue picker suggestions — response body — sections array item issues array item
`issues (anyOf 2)`	null	Alternative
`label`	JSON	Optional
`label (anyOf 1)`	string	Alternative	The label of the type of issues suggested for use in auto-completion. Read only: true
`label (anyOf 2)`	null	Alternative
`msg`	JSON	Optional
`msg (anyOf 1)`	string	Alternative	If no issue suggestions are found, returns a message indicating no suggestions were found, Read only: true
`msg (anyOf 2)`	null	Alternative
`sub`	JSON	Optional
`sub (anyOf 1)`	string	Alternative	If issue suggestions are found, returns a message indicating the number of issues suggestions found and returned. Read only: true
`sub (anyOf 2)`	null	Alternative

Referenced models: Get issue picker suggestions — response body — sections array item issues array item

Get issue picker suggestions — response body — sections array item issues array item

Field	Type	Presence	Description and constraints
`$`	object	Root	An issue suggested for use in the issue picker auto-completion.
`id`	JSON	Optional
`id (anyOf 1)`	JSON	Alternative
`id (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the issue. Format: int64 Read only: true
`id (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`id (anyOf 2)`	null	Alternative
`img`	JSON	Optional
`img (anyOf 1)`	string	Alternative	The URL of the issue type's avatar. Read only: true
`img (anyOf 2)`	null	Alternative
`key`	JSON	Optional
`key (anyOf 1)`	string	Alternative	The key of the issue. Read only: true
`key (anyOf 2)`	null	Alternative
`keyHtml`	JSON	Optional
`keyHtml (anyOf 1)`	string	Alternative	The key of the issue in HTML format. Read only: true
`keyHtml (anyOf 2)`	null	Alternative
`summary`	JSON	Optional
`summary (anyOf 1)`	string	Alternative	The phrase containing the query string in HTML format, with the string highlighted with HTML bold tags. Read only: true
`summary (anyOf 2)`	null	Alternative
`summaryText`	JSON	Optional
`summaryText (anyOf 1)`	string	Alternative	The phrase containing the query string, as plain text. Read only: true
`summaryText (anyOf 2)`	null	Alternative

Search for issues using JQL enhanced search (GET) — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	The result of a JQL search with issues reconsilation.
`isLast`	JSON	Optional
`isLast (anyOf 1)`	boolean	Alternative	Indicates whether this is the last page of the paginated response. Read only: true
`isLast (anyOf 2)`	null	Alternative
`issues`	JSON	Optional
`issues (anyOf 1)`	array	Alternative	The list of issues found by the search or reconsiliation. Read only: true
`issues (anyOf 1)[]`	Model	Each item	Expand Get issue — response body
`issues (anyOf 2)`	null	Alternative
`names`	JSON	Optional
`names (anyOf 1)`	object	Alternative	The ID and name of each field in the search results. Read only: true Additional keys: see wildcard field
`names (anyOf 1).*`	string	Additional keys	Read only: true
`names (anyOf 2)`	null	Alternative
`nextPageToken`	JSON	Optional
`nextPageToken (anyOf 1)`	string	Alternative	Continuation token to fetch the next page. If this result represents the last or the only page this token will be null. This token will expire in 7 days. Read only: true
`nextPageToken (anyOf 2)`	null	Alternative
`schema`	JSON	Optional
`schema (anyOf 1)`	object	Alternative	The schema describing the field types in the search results. Read only: true Additional keys: see wildcard field
`schema (anyOf 1).*`	Model	Additional keys	Expand Create custom field — response body — schema The schema of a field
`schema (anyOf 2)`	null	Alternative
`warnings`	JSON	Optional
`warnings (anyOf 1)`	array	Alternative	Experimental. Warnings generated during the search, e.g. when a JQL clause exceeded its argument limit or when the result set was truncated due to an ingestion limit. This field is currently rolling out behind a feature flag and may be absent, empty, or change shape without notice until generally available. Read only: true
`warnings (anyOf 1)[]`	Model	Each item	Expand Search for issues using JQL enhanced search (GET) — response body — warnings array item
`warnings (anyOf 2)`	null	Alternative

Referenced models: Get issue — response body, Create custom field — response body — schema The schema of a field, Search for issues using JQL enhanced search (GET) — response body — warnings array item

Search for issues using JQL enhanced search (GET) — response body — warnings array item

Field	Type	Presence	Description and constraints
`$`	object	Root	Experimental. A warning returned alongside successful search results.
`details`	JSON	Optional
`details (anyOf 1)`	Model	Alternative	Expand Search for issues using JQL enhanced search (GET) — response body — warnings array item details actual, arguments, clause, limit Structured details about the warning, if available.
`details (anyOf 2)`	null	Alternative
`message`	JSON	Optional
`message (anyOf 1)`	string	Alternative	A human-readable explanation of the warning suitable for surfacing to end users. Read only: true
`message (anyOf 2)`	null	Alternative
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	The type of warning, e.g. CLAUSE\_LIMIT\_EXCEEDED. Read only: true
`type (anyOf 2)`	null	Alternative

Referenced models: Search for issues using JQL enhanced search (GET) — response body — warnings array item details actual, arguments, clause, limit

Search for issues using JQL enhanced search (GET) — response body — warnings array item details actual, arguments, clause, limit

Field	Type	Presence	Description and constraints
`$`	object	Root	Experimental. Structured details about a JQL clause exceeding its argument limit.
`actual`	JSON	Optional
`actual (anyOf 1)`	JSON	Alternative
`actual (anyOf 1) (anyOf 1)`	integer	Alternative	The actual number of arguments supplied that exceeded the limit. Format: int64 Read only: true
`actual (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`actual (anyOf 2)`	null	Alternative
`arguments`	JSON	Optional
`arguments (anyOf 1)`	string	Alternative	The arguments passed to the JQL clause. Read only: true
`arguments (anyOf 2)`	null	Alternative
`clause`	JSON	Optional
`clause (anyOf 1)`	string	Alternative	The JQL clause that triggered the limit, e.g. issueHistory(). Read only: true
`clause (anyOf 2)`	null	Alternative
`limit`	JSON	Optional
`limit (anyOf 1)`	JSON	Alternative
`limit (anyOf 1) (anyOf 1)`	integer	Alternative	The maximum number of arguments allowed for the clause. Format: int64 Read only: true
`limit (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`limit (anyOf 2)`	null	Alternative

Search for issues using JQL enhanced search (POST) — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`expand`	string	Optional	Use [expand](#expansion) to include additional information about issues in the response. Note that, unlike the majority of instances where `expand` is specified, `expand` is defined as a comma-delimited string of values. The expand options are: * `renderedFields` Returns field values rendered in HTML format. * `names` Returns the display name of each field. * `schema` Returns the schema describing a field type. * `transitions` Returns all possible transitions for the issue. * `operations` Returns all possible operations for the issue. * `editmeta` Returns information about how each field can be edited. * `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent. * `versionedRepresentations` Instead of `fields`, returns `versionedRepresentations` a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version. Examples: `"names,changelog"` Returns the display name of each field as well as a list of recent updates to an issue.
`fields`	array	Optional	A list of fields to return for each issue. Use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include: * `all` Returns all fields. `navigable` Returns navigable fields. `id` Returns only issue IDs. * Any issue field, prefixed with a dash to exclude. The default is `id`. Examples: * `summary,comment` Returns the summary and comments fields only. * `*all,-comment` Returns all fields except comments. Multiple `fields` parameters can be included in a request. Note: By default, this resource returns IDs only. This differs from [GET issue](#api-rest-api-3-issue-issueIdOrKey-get) where the default is all fields.
`fields[]`	string	Each item
`fieldsByKeys`	boolean	Optional	Reference fields by their key (rather than ID). The default is `false`.
`includeArchivedProjects`	boolean	Optional	Whether to also return issues that belong to archived projects. Archived projects are excluded by default. Requires Browse projects permission on the archived project. The default is `false`.
`jql`	string	Optional	A [JQL](https://confluence.atlassian.com/x/egORLQ) expression. For performance reasons, this parameter requires a bounded query. A bounded query is a query with a search restriction. * Example of an unbounded query: `order by key desc`. * Example of a bounded query: `assignee = currentUser() order by key`. Additionally, `orderBy` clause can contain a maximum of 7 fields.
`maxResults`	integer	Optional	The maximum number of items to return per page. To manage page size, API may return fewer items per page where a large number of fields are requested. The greatest number of items returned per page is achieved when requesting `id` or `key` only. It returns max 5000 issues. Default: 50 Format: int32
`nextPageToken`	string	Optional	The token for a page to fetch that is not the first page. The first page has a `nextPageToken` of `null`. Use the `nextPageToken` to fetch the next page of issues.
`properties`	array	Optional	A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list.
`properties[]`	string	Each item
`reconcileIssues`	array	Optional	Strong consistency issue ids to be reconciled with search results. Accepts max 50 ids. This list of ids should be consistent with each paginated request across different pages.
`reconcileIssues[]`	integer	Each item	Format: int64

Report an issue with this page