POST /rest/api/2/app/field/context/configuration/list
Returns a paginated list of configurations for list of custom fields of a type created by a Forge app.
The result can be filtered by one of these criteria:
id.fieldContextId.issueId.projectKeyOrIdandissueTypeId.
Otherwise, all configurations for the provided list of custom fields are returned.
Permissions required: Administer Jira global permission. Jira permissions are not required for the Forge app that provided the custom field type.
Servers
- https://your-domain.atlassian.net
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
id[] |
Array | No |
The list of configuration IDs. To include multiple configurations, separate IDs with an ampersand: |
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: 100 |
fieldContextId[] |
Array | No |
The list of field context IDs. To include multiple field contexts, separate IDs with an ampersand: |
projectKeyOrId |
String | No |
The ID or key of the project to filter results by. Must be provided with |
issueId |
Integer | No |
The ID of the issue to filter results by. If the issue doesn't exist, an empty list is returned. Can't be provided with |
issueTypeId |
String | No |
The ID of the issue type to filter results by. Must be provided with |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
fieldIdsOrKeys[] |
Array | Yes |
List of IDs or keys of the custom fields. It can be a mix of IDs and keys in the same query. |
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.