Get Custom Field Contexts
GET {{baseUrl}}/rest/api/3/field/:fieldId/context?isAnyIssueType=<boolean>&isGlobalContext=<boolean>&contextId=<long>&startAt=0&maxResults=50
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
idonly, 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.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
isAnyIssueType | string | Whether to return contexts that apply to all issue types. | |
isGlobalContext | string | Whether to return contexts that apply to all projects. | |
contextId | string | The list of context IDs. To include multiple contexts, separate IDs with ampersand: contextId=10000&contextId=10001. | |
startAt | number | The index of the first item to return in a page of results (page offset). | |
maxResults | number | The maximum number of items to return per page. |
RESPONSES
status: OK
{"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}]}