Get field reference data (GET)

Returns reference data for JQL searches. This is a downloadable version of the documentation provided in Advanced searching - fields reference and Advanced searching - functions reference, 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 Get field reference data (POST) can be used.

This operation can be accessed anonymously.

Permissions required: None.

{ "visibleFieldNames": [ { "value": "summary", "displayName": "summary", "orderable": "true", "searchable": "true", "operators": [ "~", "!~", "is", "is not" ], "types": [ "java.lang.String" ] }, { "value": "Sprint", "displayName": "Sprint - cf[10880]", "orderable": "true", "searchable": "true", "auto": "true", "cfid": "cf[10880]", "operators": [ "=", "!=", "in", "not in", "is", "is not" ], "types": [ "com.atlassian.greenhopper.service.sprint.Sprint" ] } ], "visibleFunctionNames": [ { "value": "standardIssueTypes()", "displayName": "standardIssueTypes()", "isList": "true", "types": [ "com.atlassian.jira.issue.issuetype.IssueType" ] } ], "jqlReservedWords": [ "empty", "and", "or", "in", "distinct" ] }

Responses

🟢200Returned if the request is successful.

application/json

Body

Lists of JQL reference data.

jqlReservedWords

array[string]

optional

List of JQL query reserved words.

visibleFieldNames

array[object (FieldReferenceData) {10}]

optional

List of fields usable in JQL queries.

auto

enum<string>

optional

Whether the field provide auto-complete suggestions.

Allowed values:

truefalse

cfid

string

optional

If the item is a custom field, the ID of the custom field.

deprecated

enum<string>

optional

Whether this field has been deprecated.

Allowed values:

truefalse

deprecatedSearcherKey

string

optional

The searcher key of the field, only passed when the field is deprecated.

displayName

string

optional

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].

operators

array[string]

optional

The valid search operators for the field.

orderable

enum<string>

optional

Whether the field can be used in a query's ORDER BY clause.

Allowed values:

truefalse

searchable

enum<string>

optional

Whether the content of this field can be searched.

Allowed values:

truefalse

types

array[string]

optional

The data types of items in the field.

value

string

optional

The field identifier.

visibleFunctionNames

array[object (FunctionReferenceData) {4}]

optional

List of functions usable in JQL queries.

displayName

string

optional

The display name of the function.

isList

enum<string>

optional

Whether the function can take a list of arguments.

Allowed values:

truefalse

types

array[string]

optional

The data types returned by the function.

value

string

optional

The function identifier.

🟠401Returned if the authentication credentials are incorrect.

Get field reference data (GET)

Request

Responses