v4

latestOpenAPI 3.0.1Apache 2.02026-08-016079122.3 MB
Issue custom field contexts

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. Edit Workflow edit workflow permission

get/rest/api/2/field/{fieldId}/context

Path parameters

fieldIdstring required

The ID of the custom field.

Query parameters

isAnyIssueTypeboolean

Whether to return contexts that apply to all issue types.

isGlobalContextboolean

Whether to return contexts that apply to all projects.

contextIdinteger[]

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

startAtinteger

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

maxResultsinteger

The maximum number of items to return per page.

Response

Returned if the request is successful.

isLastboolean

Whether this is the last page.

maxResultsinteger

The maximum number of items that could be returned.

nextPagestring uri

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

selfstring uri

The URL of the page.

startAtinteger

The index of the first item returned.

totalinteger

The number of items returned.