GET /rest/api/2/field/{fieldId}/context
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. Edit Workflow edit workflow permission
Servers
- https://your-domain.atlassian.net
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
fieldId |
String | Yes |
The ID of the custom field. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
startAt |
Integer | No |
The index of the first item to return in a page of results (page offset). Default value: 0 |
maxResults |
Integer | No |
The maximum number of items to return per page. Default value: 50 |
isAnyIssueType |
Boolean | No |
Whether to return contexts that apply to all issue types. |
isGlobalContext |
Boolean | No |
Whether to return contexts that apply to all projects. |
contextId[] |
Array | No |
The list of context IDs. To include multiple contexts, separate IDs with ampersand: |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.