PUT /rest/api/2/app/field/{fieldIdOrKey}/context/configuration
Update the configuration for contexts of a custom field of a type 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 type.
Servers
- https://your-domain.atlassian.net
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
fieldIdOrKey |
String | Yes |
The ID or key of the custom field, for example |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
configurations[] |
Array | Yes |
The list of custom field configuration details. |
configurations[].id |
String | Yes |
The ID of the configuration. |
configurations[].fieldContextId |
String | Yes |
The ID of the field context the configuration is associated with. |
configurations[].schema |
No |
The field value schema. |
|
configurations[].configuration |
No |
The field configuration. |
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.