{
"opencollection": "1.0.0",
"info": {
"name": "Atlassian Admin Account Issue Custom Field Configuration (Apps) API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "Issue Custom Field Configuration (Apps)",
"type": "folder"
},
"items": [
{
"info": {
"name": "Atlassian Get Custom Field Configurations",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/api/3/app/field/:fieldIdOrKey/context/configuration",
"params": [
{
"name": "fieldIdOrKey",
"value": "",
"type": "path",
"description": "The ID or key of the custom field, for example `customfield_10000`."
},
{
"name": "id",
"value": "",
"type": "query",
"description": "The list of configuration IDs. To include multiple configurations, separate IDs with an ampersand: `id=10000&id=10001`. Can't be provided with `fieldContextId`, `issueId`, `projectKeyOrId`, or `issueTypeId`."
},
{
"name": "fieldContextId",
"value": "",
"type": "query",
"description": "The list of field context IDs. To include multiple field contexts, separate IDs with an ampersand: `fieldContextId=10000&fieldContextId=10001`. Can't be provided with `id`, `issueId`, `projectKeyOrId`, or `issueTypeId`."
},
{
"name": "issueId",
"value": "",
"type": "query",
"description": "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 `projectKeyOrId`, or `issueTypeId`."
},
{
"name": "projectKeyOrId",
"value": "",
"type": "query",
"description": "The ID or key of the project to filter results by. Must be provided with `issueTypeId`. Can't be provided with `issueId`."
},
{
"name": "issueTypeId",
"value": "",
"type": "query",
"description": "The ID of the issue type to filter results by. Must be provided with `projectKeyOrId`. Can't be provided with `issueId`."
},
{
"name": "startAt",
"value": "",
"type": "query",
"description": "The index of the first item to return in a page of results (page offset)."
},
{
"name": "maxResults",
"value": "",
"type": "query",
"description": "The maximum number of items to return per page."
}
]
},
"docs": "Returns a [paginated](#pagination) list of configurations for a custom field of a [type](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/) created by a [Forge app](https://developer.atlassian.com/platform/forge/).
The result can be filtered by one of these criteria:
* `id`.
* `fieldContextId`.
* `issueId`.
* `projectKeyOrId` and `issueTypeId`.
Otherwise, all configurations are returned.
**[Permissions]("
},
{
"info": {
"name": "Atlassian Update Custom Field Configurations",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/rest/api/3/app/field/:fieldIdOrKey/context/configuration",
"params": [
{
"name": "fieldIdOrKey",
"value": "",
"type": "path",
"description": "The ID or key of the custom field, for example `customfield_10000`."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the configuration for contexts of a custom field of a [type](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/) created by a [Forge app](https://developer.atlassian.com/platform/forge/).
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the Forge app that created the custom field type."
}
]
}
],
"bundled": true
}