Atlassian: Jql schemas

37 Atlassian schemas with complete fields and constraints.

Convert user identifiers to account I Ds in JQL queries — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	The JQL queries to be converted. Additional keys: not allowed
`queryStrings`	array	Optional	A list of queries with user identifiers. Maximum of 100 queries.
`queryStrings[]`	string	Each item

Convert user identifiers to account I Ds in JQL queries — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	The converted JQL queries.
`queriesWithUnknownUsers`	JSON	Optional
`queriesWithUnknownUsers (anyOf 1)`	array	Alternative	List of queries containing user information that could not be mapped to an existing user
`queriesWithUnknownUsers (anyOf 1)[]`	Model	Each item	Expand Convert user identifiers to account I Ds in JQL queries — response body — queries With Unknown Users array item
`queriesWithUnknownUsers (anyOf 2)`	null	Alternative
`queryStrings`	JSON	Optional
`queryStrings (anyOf 1)`	array	Alternative	The list of converted query strings with account IDs in place of user identifiers.
`queryStrings (anyOf 1)[]`	string	Each item
`queryStrings (anyOf 2)`	null	Alternative

Referenced models: Convert user identifiers to account I Ds in JQL queries — response body — queries With Unknown Users array item

Convert user identifiers to account I Ds in JQL queries — response body — queries With Unknown Users array item

Field	Type	Presence	Description and constraints
`$`	object	Root	JQL queries that contained users that could not be found
`convertedQuery`	JSON	Optional
`convertedQuery (anyOf 1)`	string	Alternative	The converted query, with accountIDs instead of user identifiers, or 'unknown' for users that could not be found
`convertedQuery (anyOf 2)`	null	Alternative
`originalQuery`	JSON	Optional
`originalQuery (anyOf 1)`	string	Alternative	The original query, for reference
`originalQuery (anyOf 2)`	null	Alternative

Get field auto complete suggestions — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	The results from a JQL query.
`results`	JSON	Optional
`results (anyOf 1)`	array	Alternative	The list of suggested item.
`results (anyOf 1)[]`	Model	Each item	Expand Get field auto complete suggestions — response body — results The list of suggested item item
`results (anyOf 2)`	null	Alternative

Referenced models: Get field auto complete suggestions — response body — results The list of suggested item item

Get field auto complete suggestions — response body — results The list of suggested item item

Field	Type	Presence	Description and constraints
`$`	object	Root	A field auto-complete suggestion.
`displayName`	JSON	Optional
`displayName (anyOf 1)`	string	Alternative	The display name of a suggested item. If `fieldValue` or `predicateValue` are provided, the matching text is highlighted with the HTML bold tag.
`displayName (anyOf 2)`	null	Alternative
`value`	JSON	Optional
`value (anyOf 1)`	string	Alternative	The value of a suggested item.
`value (anyOf 2)`	null	Alternative

Get field reference data (GET) — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Lists of JQL reference data.
`jqlReservedWords`	JSON	Optional
`jqlReservedWords (anyOf 1)`	array	Alternative	List of JQL query reserved words.
`jqlReservedWords (anyOf 1)[]`	string	Each item
`jqlReservedWords (anyOf 2)`	null	Alternative
`visibleFieldNames`	JSON	Optional
`visibleFieldNames (anyOf 1)`	array	Alternative	List of fields usable in JQL queries.
`visibleFieldNames (anyOf 1)[]`	Model	Each item	Expand Get field reference data (GET) — response body — visible Field Names List of fields usable in JQL queries item
`visibleFieldNames (anyOf 2)`	null	Alternative
`visibleFunctionNames`	JSON	Optional
`visibleFunctionNames (anyOf 1)`	array	Alternative	List of functions usable in JQL queries.
`visibleFunctionNames (anyOf 1)[]`	Model	Each item	Expand Get field reference data (GET) — response body — visible Function Names List of functions usable in JQL queries item
`visibleFunctionNames (anyOf 2)`	null	Alternative

Referenced models: Get field reference data (GET) — response body — visible Field Names List of fields usable in JQL queries item, Get field reference data (GET) — response body — visible Function Names List of functions usable in JQL queries item

Get field reference data (GET) — response body — visible Field Names List of fields usable in JQL queries item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a field that can be used in advanced searches.
`auto`	JSON	Optional
`auto (anyOf 1)`	string	Alternative	Whether the field provide auto-complete suggestions. Known values: true, false
`auto (anyOf 2)`	null	Alternative
`cfid`	JSON	Optional
`cfid (anyOf 1)`	string	Alternative	If the item is a custom field, the ID of the custom field.
`cfid (anyOf 2)`	null	Alternative
`deprecated`	JSON	Optional
`deprecated (anyOf 1)`	string	Alternative	Whether this field has been deprecated. Known values: true, false
`deprecated (anyOf 2)`	null	Alternative
`deprecatedSearcherKey`	JSON	Optional
`deprecatedSearcherKey (anyOf 1)`	string	Alternative	The searcher key of the field, only passed when the field is deprecated.
`deprecatedSearcherKey (anyOf 2)`	null	Alternative
`displayName`	JSON	Optional
`displayName (anyOf 1)`	string	Alternative	The display name contains the following: * for system fields, the field name. For example, `Summary`. * for collapsed custom fields, the field name followed by a hyphen and then the field name and field type. For example, `Component - Component[Dropdown]`. * for other custom fields, the field name followed by a hyphen and then the custom field ID. For example, `Component - cf[10061]`.
`displayName (anyOf 2)`	null	Alternative
`operators`	JSON	Optional
`operators (anyOf 1)`	array	Alternative	The valid search operators for the field.
`operators (anyOf 1)[]`	string	Each item
`operators (anyOf 2)`	null	Alternative
`orderable`	JSON	Optional
`orderable (anyOf 1)`	string	Alternative	Whether the field can be used in a query's `ORDER BY` clause. Known values: true, false
`orderable (anyOf 2)`	null	Alternative
`searchable`	JSON	Optional
`searchable (anyOf 1)`	string	Alternative	Whether the content of this field can be searched. Known values: true, false
`searchable (anyOf 2)`	null	Alternative
`types`	JSON	Optional
`types (anyOf 1)`	array	Alternative	The data types of items in the field.
`types (anyOf 1)[]`	string	Each item
`types (anyOf 2)`	null	Alternative
`value`	JSON	Optional
`value (anyOf 1)`	string	Alternative	The field identifier.
`value (anyOf 2)`	null	Alternative

Get field reference data (GET) — response body — visible Function Names List of functions usable in JQL queries item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of functions that can be used in advanced searches.
`displayName`	JSON	Optional
`displayName (anyOf 1)`	string	Alternative	The display name of the function.
`displayName (anyOf 2)`	null	Alternative
`isList`	JSON	Optional
`isList (anyOf 1)`	string	Alternative	Whether the function can take a list of arguments. Known values: true, false
`isList (anyOf 2)`	null	Alternative
`supportsListAndSingleValueOperators`	JSON	Optional
`supportsListAndSingleValueOperators (anyOf 1)`	string	Alternative	Whether the function supports both single and list value operators. Known values: true, false
`supportsListAndSingleValueOperators (anyOf 2)`	null	Alternative
`types`	JSON	Optional
`types (anyOf 1)`	array	Alternative	The data types returned by the function.
`types (anyOf 1)[]`	string	Each item
`types (anyOf 2)`	null	Alternative
`value`	JSON	Optional
`value (anyOf 1)`	string	Alternative	The function identifier.
`value (anyOf 2)`	null	Alternative

Get field reference data (POST) — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of how to filter and list search auto complete information. Additional keys: not allowed
`includeCollapsedFields`	boolean	Optional	Include collapsed fields for fields that have non-unique names. Default: false
`projectIds`	array	Optional	List of project IDs used to filter the visible field details returned.
`projectIds[]`	integer	Each item	Format: int64

Get invalid JQL searches — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`entries`	JSON	Optional
`entries (anyOf 1)`	array	Alternative
`entries (anyOf 1)[]`	Model	Each item	Expand Get invalid JQL searches — response body — entries array item
`entries (anyOf 2)`	null	Alternative
`isLast`	JSON	Optional
`isLast (anyOf 1)`	boolean	Alternative
`isLast (anyOf 2)`	null	Alternative
`nextPageToken`	JSON	Optional
`nextPageToken (anyOf 1)`	string	Alternative
`nextPageToken (anyOf 2)`	null	Alternative
`nextPageURL`	JSON	Optional
`nextPageURL (anyOf 1)`	string	Alternative
`nextPageURL (anyOf 2)`	null	Alternative

Referenced models: Get invalid JQL searches — response body — entries array item

Get invalid JQL searches — response body — entries array item

Field	Type	Presence	Description and constraints
`$`	object	Root
`caller`	JSON	Optional
`caller (anyOf 1)`	string	Alternative
`caller (anyOf 2)`	null	Alternative
`createdAt`	JSON	Optional
`createdAt (anyOf 1)`	string	Alternative
`createdAt (anyOf 2)`	null	Alternative
`filterId`	JSON	Optional
`filterId (anyOf 1)`	string	Alternative
`filterId (anyOf 2)`	null	Alternative
`jql`	JSON	Optional
`jql (anyOf 1)`	string	Alternative
`jql (anyOf 2)`	null	Alternative
`requestUrl`	JSON	Optional
`requestUrl (anyOf 1)`	string	Alternative
`requestUrl (anyOf 2)`	null	Alternative
`user`	JSON	Optional
`user (anyOf 1)`	Model	Alternative	Expand Get invalid JQL searches — response body — entries array item user account Id, active, avatar Urls, display Name, key, name, self
`user (anyOf 2)`	null	Alternative
`userAgent`	JSON	Optional
`userAgent (anyOf 1)`	string	Alternative
`userAgent (anyOf 2)`	null	Alternative
`validationMessage`	JSON	Optional
`validationMessage (anyOf 1)`	string	Alternative
`validationMessage (anyOf 2)`	null	Alternative

Referenced models: Get invalid JQL searches — response body — entries array item user account Id, active, avatar Urls, display Name, key, name, self

Get invalid JQL searches — response body — entries array item user account Id, active, avatar Urls, display Name, key, name, self

Field	Type	Presence	Description and constraints
`$`	object	Root
`accountId`	JSON	Optional
`accountId (anyOf 1)`	string	Alternative
`accountId (anyOf 2)`	null	Alternative
`active`	JSON	Optional
`active (anyOf 1)`	boolean	Alternative
`active (anyOf 2)`	null	Alternative
`avatarUrls`	JSON	Optional
`avatarUrls (anyOf 1)`	Model	Alternative	Expand Get invalid JQL searches — response body — entries array item user account Id, active, avatar Urls, display Name, key, name, self avatar Urls 16x16, 24x24, 32x32, 48x48
`avatarUrls (anyOf 2)`	null	Alternative
`displayName`	JSON	Optional
`displayName (anyOf 1)`	string	Alternative
`displayName (anyOf 2)`	null	Alternative
`key`	JSON	Optional
`key (anyOf 1)`	string	Alternative
`key (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative
`name (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	Format: uri
`self (anyOf 2)`	null	Alternative

Referenced models: Get invalid JQL searches — response body — entries array item user account Id, active, avatar Urls, display Name, key, name, self avatar Urls 16x16, 24x24, 32x32, 48x48

Get invalid JQL searches — response body — entries array item user account Id, active, avatar Urls, display Name, key, name, self avatar Urls 16x16, 24x24, 32x32, 48x48

Field	Type	Presence	Description and constraints
`$`	object	Root
`16x16`	JSON	Optional
`16x16 (anyOf 1)`	string	Alternative	Format: uri
`16x16 (anyOf 2)`	null	Alternative
`24x24`	JSON	Optional
`24x24 (anyOf 1)`	string	Alternative	Format: uri
`24x24 (anyOf 2)`	null	Alternative
`32x32`	JSON	Optional
`32x32 (anyOf 1)`	string	Alternative	Format: uri
`32x32 (anyOf 2)`	null	Alternative
`48x48`	JSON	Optional
`48x48 (anyOf 1)`	string	Alternative	Format: uri
`48x48 (anyOf 2)`	null	Alternative

Parse JQL query — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	A list of JQL queries to parse. write Only: true Additional keys: not allowed
`queries`	array	Required within parent	A list of queries to parse. Minimum length: 1
`queries[]`	string	Each item	Minimum length: 1

Parse JQL query — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A list of parsed JQL queries.
`queries`	JSON	Optional
`queries (anyOf 1)`	array	Alternative	A list of parsed JQL queries. Minimum length: 1
`queries (anyOf 1)[]`	Model	Each item	Expand Parse JQL query — response body — queries A list of parsed JQL queries item
`queries (anyOf 2)`	null	Alternative

Referenced models: Parse JQL query — response body — queries A list of parsed JQL queries item

Parse JQL query — response body — queries A list of parsed JQL queries item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a parsed JQL query. Minimum length: 1
`errors`	JSON	Optional
`errors (anyOf 1)`	array	Alternative	The list of syntax or validation errors. Unique items: true
`errors (anyOf 1)[]`	string	Each item
`errors (anyOf 2)`	null	Alternative
`query`	JSON	Optional
`query (anyOf 1)`	string	Alternative	The JQL query that was parsed and validated.
`query (anyOf 2)`	null	Alternative
`structure`	JSON	Optional
`structure (anyOf 1)`	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query The syntax tree of the query. Empty if the query was invalid.
`structure (anyOf 2)`	null	Alternative
`warnings`	JSON	Optional
`warnings (anyOf 1)`	array	Alternative	The list of warning messages Unique items: true
`warnings (anyOf 1)[]`	string	Each item
`warnings (anyOf 2)`	null	Alternative

Referenced models: Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query

Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query

Field	Type	Presence	Description and constraints
`$`	object	Root	A parsed JQL query.
`orderBy`	JSON	Optional
`orderBy (anyOf 1)`	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query order By Details of the order-by JQL clause
`orderBy (anyOf 2)`	null	Alternative
`where`	JSON	Optional
`where (anyOf 1)`	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause
`where (anyOf 2)`	null	Alternative

Referenced models: Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause, Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query order By Details of the order-by JQL clause

Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query order By Details of the order-by JQL clause

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of the order-by JQL clause.
`fields`	JSON	Optional
`fields (anyOf 1)`	array	Alternative	The list of order-by clause fields and their ordering directives.
`fields (anyOf 1)[]`	Model	Each item	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query order By Details of the order-by JQL clause fields array item
`fields (anyOf 2)`	null	Alternative

Referenced models: Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query order By Details of the order-by JQL clause fields array item

Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query order By Details of the order-by JQL clause fields array item

Field	Type	Presence	Description and constraints
`$`	object	Root	An element of the order-by JQL clause.
`direction`	JSON	Optional
`direction (anyOf 1)`	string	Alternative	The direction in which to order the results. Known values: asc, desc
`direction (anyOf 2)`	null	Alternative
`field`	JSON	Optional
`field (anyOf 1)`	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator field encoded Name, name, property
`field (anyOf 2)`	null	Alternative

Referenced models: Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator field encoded Name, name, property

Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause

Field	Type	Presence	Description and constraints
`$`	object	Root	A JQL query clause.
`$ (anyOf 1)`	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause clauses, operator
`$ (anyOf 2)`	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator
`$ (anyOf 3)`	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator, predicates
`$ (anyOf 4)`	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operator, predicates

Referenced models: Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause clauses, operator, Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operator, predicates, Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator, Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator, predicates

Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause clauses, operator

Field	Type	Presence	Description and constraints
`$`	object	Root	A JQL query clause that consists of nested clauses. For example, `(labels in (urgent, blocker) OR lastCommentedBy = currentUser()). Note that, where nesting is not defined, the parser nests JQL clauses based on the operator precedence. For example, "A OR B AND C" is parsed as "(A OR B) AND C". See Setting the precedence of operators for more information about precedence in JQL queries.`
`clauses`	JSON	Optional
`clauses (anyOf 1)`	array	Alternative	The list of nested clauses.
`clauses (anyOf 1)[]`	Model	Each item	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause
`clauses (anyOf 2)`	null	Alternative
`operator`	JSON	Optional
`operator (anyOf 1)`	string	Alternative	The operator between the clauses. Known values: and, or, not
`operator (anyOf 2)`	null	Alternative

Referenced models: Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause

Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator

Field	Type	Presence	Description and constraints
`$`	object	Root	A clause that asserts the current value of a field. For example, `summary ~ test`.
`field`	JSON	Optional
`field (anyOf 1)`	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator field encoded Name, name, property
`field (anyOf 2)`	null	Alternative
`operand`	JSON	Optional
`operand (anyOf 1)`	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator operand Details of an operand in a JQL clause
`operand (anyOf 2)`	null	Alternative
`operator`	JSON	Optional
`operator (anyOf 1)`	string	Alternative	The operator between the field and operand. Known values: =, !=, >, <, >=, <=, in, not in, ~, ~=, is, is not
`operator (anyOf 2)`	null	Alternative

Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator field encoded Name, name, property

Field	Type	Presence	Description and constraints
`$`	object	Root	A field used in a JQL query. See [Advanced searching - fields reference](https://confluence.atlassian.com/x/dAiiLQ) for more information about fields in JQL queries.
`encodedName`	JSON	Optional
`encodedName (anyOf 1)`	string	Alternative	The encoded name of the field, which can be used directly in a JQL query.
`encodedName (anyOf 2)`	null	Alternative
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative	The name of the field.
`name (anyOf 2)`	null	Alternative
`property`	JSON	Optional
`property (anyOf 1)`	array	Alternative	When the field refers to a value in an entity property, details of the entity property value.
`property (anyOf 1)[]`	Model	Each item	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator field encoded Name, name, property property array item
`property (anyOf 2)`	null	Alternative

Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator field encoded Name, name, property property array item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of an entity property.
`entity`	JSON	Optional
`entity (anyOf 1)`	string	Alternative	The object on which the property is set.
`entity (anyOf 2)`	null	Alternative
`key`	JSON	Optional
`key (anyOf 1)`	string	Alternative	The key of the property.
`key (anyOf 2)`	null	Alternative
`path`	JSON	Optional
`path (anyOf 1)`	string	Alternative	The path in the property value to query.
`path (anyOf 2)`	null	Alternative
`type`	JSON	Optional
`type (anyOf 1)`	string	Alternative	The type of the property value extraction. Not available if the extraction for the property is not registered on the instance with the [Entity property](https://developer.atlassian.com/cloud/jira/platform/modules/entity-property/) module. Known values: number, string, text, date, user
`type (anyOf 2)`	null	Alternative

Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator operand Details of an operand in a JQL clause

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of an operand in a JQL clause.
`$ (anyOf 1)`	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator operand Details of an operand in a JQL clause An operand that is a list of values
`$ (anyOf 2)`	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator operand Details of an operand in a JQL clause An operand that is a user-provided value
`$ (anyOf 3)`	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator operand Details of an operand in a JQL clause arguments, encoded Operand, function
`$ (anyOf 4)`	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator operand Details of an operand in a JQL clause keyword

Referenced models: Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator operand Details of an operand in a JQL clause arguments, encoded Operand, function, Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator operand Details of an operand in a JQL clause keyword, Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator operand Details of an operand in a JQL clause An operand that is a list of values, Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator operand Details of an operand in a JQL clause An operand that is a user-provided value

Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator operand Details of an operand in a JQL clause An operand that is a list of values

Field	Type	Presence	Description and constraints
`$`	object	Root	An operand that is a list of values.
`encodedOperand`	JSON	Optional
`encodedOperand (anyOf 1)`	string	Alternative	Encoded operand, which can be used directly in a JQL query.
`encodedOperand (anyOf 2)`	null	Alternative
`values`	JSON	Optional
`values (anyOf 1)`	array	Alternative	The list of operand values. Minimum length: 1
`values (anyOf 1)[]`	Model	Each item	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator operand Details of an operand in a JQL clause An operand that is a list of values values The list of operand values item
`values (anyOf 2)`	null	Alternative

Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator operand Details of an operand in a JQL clause An operand that is a list of values values The list of operand values item

Field	Type	Presence	Description and constraints
`$`	object	Root	An operand that can be part of a list operand.
`$ (anyOf 1)`	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator operand Details of an operand in a JQL clause An operand that is a user-provided value
`$ (anyOf 2)`	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator operand Details of an operand in a JQL clause arguments, encoded Operand, function
`$ (anyOf 3)`	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator operand Details of an operand in a JQL clause keyword

Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator operand Details of an operand in a JQL clause An operand that is a user-provided value

Field	Type	Presence	Description and constraints
`$`	object	Root	An operand that is a user-provided value.
`encodedValue`	JSON	Optional
`encodedValue (anyOf 1)`	string	Alternative	Encoded value, which can be used directly in a JQL query.
`encodedValue (anyOf 2)`	null	Alternative
`value`	JSON	Optional
`value (anyOf 1)`	string	Alternative	The operand value.
`value (anyOf 2)`	null	Alternative

Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator operand Details of an operand in a JQL clause arguments, encoded Operand, function

Field	Type	Presence	Description and constraints
`$`	object	Root	An operand that is a function. See [Advanced searching - functions reference](https://confluence.atlassian.com/x/dwiiLQ) for more information about JQL functions.
`arguments`	JSON	Optional
`arguments (anyOf 1)`	array	Alternative	The list of function arguments.
`arguments (anyOf 1)[]`	string	Each item
`arguments (anyOf 2)`	null	Alternative
`encodedOperand`	JSON	Optional
`encodedOperand (anyOf 1)`	string	Alternative	Encoded operand, which can be used directly in a JQL query.
`encodedOperand (anyOf 2)`	null	Alternative
`function`	JSON	Optional
`function (anyOf 1)`	string	Alternative	The name of the function.
`function (anyOf 2)`	null	Alternative

Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator operand Details of an operand in a JQL clause keyword

Field	Type	Presence	Description and constraints
`$`	object	Root	An operand that is a JQL keyword. See [Advanced searching - keywords reference](https://confluence.atlassian.com/jiracorecloud/advanced-searching-keywords-reference-765593717.html#Advancedsearching-keywordsreference-EMPTYEMPTY) for more information about operand keywords.
`keyword`	JSON	Optional
`keyword (anyOf 1)`	string	Alternative	The keyword that is the operand value. Known values: empty
`keyword (anyOf 2)`	null	Alternative

Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator, predicates

Field	Type	Presence	Description and constraints
`$`	object	Root	A clause that asserts a previous value of a field. For example, `status WAS "Resolved" BY currentUser() BEFORE "2019/02/02"`. See [WAS](https://confluence.atlassian.com/x/dgiiLQ#Advancedsearching-operatorsreference-WASWAS) for more information about the WAS operator.
`field`	JSON	Optional
`field (anyOf 1)`	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator field encoded Name, name, property
`field (anyOf 2)`	null	Alternative
`operand`	JSON	Optional
`operand (anyOf 1)`	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator operand Details of an operand in a JQL clause
`operand (anyOf 2)`	null	Alternative
`operator`	JSON	Optional
`operator (anyOf 1)`	string	Alternative	The operator between the field and operand. Known values: was, was in, was not in, was not
`operator (anyOf 2)`	null	Alternative
`predicates`	JSON	Optional
`predicates (anyOf 1)`	array	Alternative	The list of time predicates.
`predicates (anyOf 1)[]`	Model	Each item	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operator, predicates predicates The list of time predicates item
`predicates (anyOf 2)`	null	Alternative

Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operator, predicates

Field	Type	Presence	Description and constraints
`$`	object	Root	A clause that asserts whether a field was changed. For example, `status CHANGED AFTER startOfMonth(-1M)`.See [CHANGED](https://confluence.atlassian.com/x/dgiiLQ#Advancedsearching-operatorsreference-CHANGEDCHANGED) for more information about the CHANGED operator.
`field`	JSON	Optional
`field (anyOf 1)`	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator field encoded Name, name, property
`field (anyOf 2)`	null	Alternative
`operator`	JSON	Optional
`operator (anyOf 1)`	string	Alternative	The operator applied to the field. Known values: changed
`operator (anyOf 2)`	null	Alternative
`predicates`	JSON	Optional
`predicates (anyOf 1)`	array	Alternative	The list of time predicates.
`predicates (anyOf 1)[]`	Model	Each item	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operator, predicates predicates The list of time predicates item
`predicates (anyOf 2)`	null	Alternative

Referenced models: Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operator, predicates predicates The list of time predicates item, Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator field encoded Name, name, property

Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operator, predicates predicates The list of time predicates item

Field	Type	Presence	Description and constraints
`$`	object	Root	A time predicate for a temporal JQL clause.
`operand`	JSON	Optional
`operand (anyOf 1)`	Model	Alternative	Expand Parse JQL query — response body — queries A list of parsed JQL queries item structure A parsed JQL query where A JQL query clause field, operand, operator operand Details of an operand in a JQL clause
`operand (anyOf 2)`	null	Alternative
`operator`	JSON	Optional
`operator (anyOf 1)`	string	Alternative	The operator between the field and the operand. Known values: before, after, from, to, on, during, by
`operator (anyOf 2)`	null	Alternative

Sanitize JQL queries — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	The list of JQL queries to sanitize for the given account IDs. write Only: true Additional keys: not allowed
`queries`	array	Required within parent	The list of JQL queries to sanitize. Must contain unique values. Maximum of 20 queries.
`queries[]`	Model	Each item	Expand Sanitize JQL queries — request body — body queries item

Referenced models: Sanitize JQL queries — request body — body queries item

Sanitize JQL queries — request body — body queries item

Field	Type	Presence	Description and constraints
`$`	object	Root	The JQL query to sanitize for the account ID. If the account ID is null, sanitizing is performed for an anonymous user. write Only: true Additional keys: not allowed
`accountId`	JSON	Optional
`accountId (anyOf 1)`	string	Alternative	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Maximum length: 128
`accountId (anyOf 2)`	null	Alternative
`query`	string	Required within parent	The query to sanitize.

Sanitize JQL queries — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	The sanitized JQL queries for the given account IDs.
`queries`	JSON	Optional
`queries (anyOf 1)`	array	Alternative	The list of sanitized JQL queries.
`queries (anyOf 1)[]`	Model	Each item	Expand Sanitize JQL queries — response body — queries The list of sanitized JQL queries item
`queries (anyOf 2)`	null	Alternative

Referenced models: Sanitize JQL queries — response body — queries The list of sanitized JQL queries item

Sanitize JQL queries — response body — queries The list of sanitized JQL queries item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of the sanitized JQL query.
`accountId`	JSON	Optional
`accountId (anyOf 1)`	JSON	Alternative
`accountId (anyOf 1) (anyOf 1)`	string	Alternative	The account ID of the user for whom sanitization was performed. Maximum length: 128
`accountId (anyOf 1) (anyOf 2)`	null	Alternative
`accountId (anyOf 2)`	null	Alternative
`errors`	JSON	Optional
`errors (anyOf 1)`	Model	Alternative	Expand Validate project key — response body The list of errors.
`errors (anyOf 2)`	null	Alternative
`initialQuery`	JSON	Optional
`initialQuery (anyOf 1)`	string	Alternative	The initial query.
`initialQuery (anyOf 2)`	null	Alternative
`sanitizedQuery`	JSON	Optional
`sanitizedQuery (anyOf 1)`	JSON	Alternative
`sanitizedQuery (anyOf 1) (anyOf 1)`	string	Alternative	The sanitized query, if there were no errors.
`sanitizedQuery (anyOf 1) (anyOf 2)`	null	Alternative
`sanitizedQuery (anyOf 2)`	null	Alternative

Referenced models: Validate project key — response body

Report an issue with this page