643 matches
100 actions
The Jira Cloud platform REST
100 actions
Other/The Jira Cloud platform REST
Returns reference data for JQL searches. This is a downloadable version of the documentation provided in and , along with a list of JQL-reserved words. Use this information to assist with the programmatic creation of JQL queries or the validation of queries built in a custom query builder.
To filter visible field details by project or collapse non-unique fields by field type then can be used.
This operation can be accessed anonymously.
required: None.
{
"type": "object",
"description": "Lists of JQL reference data.",
"properties": {
"jqlReservedWords": {
"type": "array",
"description": "List of JQL query reserved words.",
"items": {
"type": "string"
}
},
"visibleFieldNames": {
"type": "array",
"description": "List of fields usable in JQL queries.",
"items": {
"type": "object",
"description": "Details of a field that can be used in advanced searches.",
"properties": {
"auto": {
"type": "string",
"description": "Whether the field provide auto-complete suggestions.",
"enum": [
"true",
"false"
]
},
"cfid": {
"type": "string",
"description": "If the item is a custom field, the ID of the custom field."
},
"deprecated": {
"type": "string",
"description": "Whether this field has been deprecated.",
"enum": [
"true",
"false"
]
},
"deprecatedSearcherKey": {
"type": "string",
"description": "The searcher key of the field, only passed when the field is deprecated."
},
"displayName": {
"type": "string",
"description": "The display name contains the following:\n\n * for system fields, the field name. For example, `Summary`.\n * for collapsed custom fields, the field name followed by a hyphen and then the field name and field type. For example, `Component - Component[Dropdown]`.\n * for other custom fields, the field name followed by a hyphen and then the custom field ID. For example, `Component - cf[10061]`."
},
"operators": {
"type": "array",
"description": "The valid search operators for the field.",
"items": {
"type": "string"
}
},
"orderable": {
"type": "string",
"description": "Whether the field can be used in a query's `ORDER BY` clause.",
"enum": [
"true",
"false"
]
},
"searchable": {
"type": "string",
"description": "Whether the content of this field can be searched.",
"enum": [
"true",
"false"
]
},
"types": {
"type": "array",
"description": "The data types of items in the field.",
"items": {
"type": "string"
}
},
"value": {
"type": "string",
"description": "The field identifier."
}
},
"additionalProperties": false
}
},
"visibleFunctionNames": {
"type": "array",
"description": "List of functions usable in JQL queries.",
"items": {
"type": "object",
"description": "Details of functions that can be used in advanced searches.",
"properties": {
"displayName": {
"type": "string",
"description": "The display name of the function."
},
"isList": {
"type": "string",
"description": "Whether the function can take a list of arguments.",
"enum": [
"true",
"false"
]
},
"types": {
"type": "array",
"description": "The data types returned by the function.",
"items": {
"type": "string"
}
},
"value": {
"type": "string",
"description": "The function identifier."
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}