Update custom field configurations

PUT

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

Update the configuration for contexts of a custom field created by a Forge app.

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 PUT 'http://jira.local:8080/jira/rest//rest/api/3/app/field//context/configuration' \
--header 'Content-Type: application/json' \
--data-raw '{
    "configurations": [
        {
            "id": "10000"
        },
        {
            "configuration": {
                "maxValue": 10000,
                "minValue": 0
            },
            "id": "10001",
            "schema": {
                "properties": {
                    "amount": {
                        "type": "number"
                    },
                    "currency": {
                        "type": "string"
                    }
                },
                "required": [
                    "amount",
                    "currency"
                ]
            }
        }
    ]
}'

Response Example

200 - Example 1

null

Request

Path Params

fieldIdOrKey

string

required

The ID or key of the custom field, for example customfield_10000.

Body Params application/json

Details of configurations for a custom field.

configurations

array[object (ContextualConfiguration) {3}]

required

The list of custom field configuration details.

>= 1 items<= 1000 items

configuration

optional

The field configuration.

string

required

The ID of the configuration.

schema

optional

The field value schema.

Examples

Responses

🟢200Returned if the request is successful.

application/json

Body

No schema defined

🟠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

Get custom field configurations

Get application property