Get custom field configurations

GET

/rest/api/3/app/field/{fieldIdOrKey}/context/configuration

Returns a paginated list of configurations for a custom field created by a Forge app.

The result can be filtered by one of these criteria:

id.

fieldContextId.

issueId.

projectKeyOrId and issueTypeId.

Otherwise, all configurations are returned.

Permissions required: Administer Jira global permission. Jira permissions are not required for the Forge app that created the custom field.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://jira.local:8080/jira/rest//rest/api/3/app/field//context/configuration'

Response Example

200 - Success

{"maxResults":1000,"startAt":0,"total":2,"isLast":true,"values":[{"id":"10000","fieldContextId":"10010"},{"id":"10001","fieldContextId":"10011","configuration":{"minValue":0,"maxValue":10000},"schema":{"properties":{"amount":{"type":"number"},"currency":{"type":"string"}},"required":["amount","currency"]}}]}

Request

Path Params

Query Params

Responses

🟢200Returned if the request is successful.

application/json

Body

🟠400Returned if the request is invalid.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠403Returned if the user is not a Jira admin or the request is not authenticated as from the app that provided the field.

🟠404Returned if the custom field is not found.

Modified at 2023-07-13 03:27:27

Update custom field value

Update custom field configurations