Get custom field contexts

Returns a paginated list of contexts for a custom field. Contexts can be returned as follows:

With no other parameters set, all contexts.

By defining id only, all contexts from the list of IDs.

By defining isAnyIssueType, limit the list of contexts returned to either those that apply to all issue types (true) or those that apply to only a subset of issue types (false)

By defining isGlobalContext, limit the list of contexts return to either those that apply to all projects (global contexts) (true) or those that apply to only a subset of projects (false).

Permissions required: Administer Jira global permission.

{"maxResults":100,"startAt":0,"total":2,"isLast":true,"values":[{"id":"10025","name":"Bug fields context","description":"A context used to define the custom field options for bugs.","isGlobalContext":true,"isAnyIssueType":false},{"id":"10026","name":"Task fields context","description":"A context used to define the custom field options for tasks.","isGlobalContext":false,"isAnyIssueType":false}]}

Request

Path Params

fieldId

string

required

The ID of the custom field.

Query Params

isAnyIssueType

string

optional

Whether to return contexts that apply to all issue types.

isGlobalContext

string

optional

Whether to return contexts that apply to all projects.

contextId

array[string]

optional

The list of context IDs. To include multiple contexts, separate IDs with ampersand: contextId=10000&contextId=10001.

startAt

integer

optional

The index of the first item to return in a page of results (page offset).

maxResults

integer

optional

The maximum number of items to return per page.

Responses

🟢200Returned if the request is successful.

application/json

Body

A page of items.

isLast

boolean

read-onlyoptional

Whether this is the last page.

maxResults

integer <int32>

read-onlyoptional

The maximum number of items that could be returned.

string <uri>

read-onlyoptional

If there is another page of results, the URL of the next page.

self

string <uri>

read-onlyoptional

The URL of the page.

startAt

integer <int64>

read-onlyoptional

The index of the first item returned.

total

integer <int64>

read-onlyoptional

The number of items returned.

values

array[object (CustomFieldContext) {5}]

read-onlyoptional

The list of items.

description

string

required

The description of the context.

string

required

The ID of the context.

isAnyIssueType

boolean

required

Whether the context apply to all issue types.

isGlobalContext

boolean

required

Whether the context is global.

name

string

required

The name of the context.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠403Returned if the user does not have the required permissions.

🟠404Returned if the custom field was not found.