PUT /rest/api/2/fieldconfiguration/{id}/fields
Updates fields in a field configuration. The properties of the field configuration fields provided override the existing values.
This operation can only update field configurations used in company-managed (classic) projects.
The operation can set the renderer for text fields to the default text renderer (text-renderer
) or wiki style renderer (wiki-renderer
). However, the renderer cannot be updated for fields using the autocomplete renderer (autocomplete-renderer
).
Permissions required: Administer Jira global permission.
Servers
- https://your-domain.atlassian.net
Path parameters
Name | Type | Required | Description |
---|---|---|---|
id |
Integer | Yes |
The ID of the field configuration. |
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 |
---|---|---|---|
fieldConfigurationItems[] |
Array | Yes |
Details of fields in a field configuration. |
fieldConfigurationItems[].id |
String | Yes |
The ID of the field within the field configuration. |
fieldConfigurationItems[].isHidden |
Boolean | No |
Whether the field is hidden in the field configuration. |
fieldConfigurationItems[].description |
String | No |
The description of the field within the field configuration. |
fieldConfigurationItems[].isRequired |
Boolean | No |
Whether the field is required in the field configuration. |
fieldConfigurationItems[].renderer |
String | No |
The renderer type for the field within 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.