PUT /rest/api/2/uiModifications/{uiModificationId}
Updates a UI modification. UI modification can only be updated by Forge apps.
Each UI modification can define up to 1000 contexts. The same context can be assigned to maximum 100 UI modifications.
Permissions required:
- None if the UI modification is created without contexts.
- Browse projects project permission for one or more projects, if the UI modification is created with contexts.
The new write:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.
Servers
- https://your-domain.atlassian.net
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
uiModificationId |
String | Yes |
The ID of the UI modification. |
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 |
|---|---|---|---|
data |
String | No |
The data of the UI modification. The maximum size of the data is 50000 characters. |
name |
String | No |
The name of the UI modification. The maximum length is 255 characters. |
description |
String | No |
The description of the UI modification. The maximum length is 255 characters. |
contexts[] |
Array | No |
List of contexts of the UI modification. The maximum number of contexts is 1000. If provided, replaces all existing contexts. |
contexts[].id |
String | No |
The ID of the UI modification context. |
contexts[].projectId |
String | No |
The project ID of the context. Null is treated as a wildcard, meaning the UI modification will be applied to all projects. Each UI modification context can have a maximum of one wildcard. |
contexts[].viewType |
String | No |
The view type of the context. Only Possible values:
|
contexts[].isAvailable |
Boolean | No |
Whether a context is available. For example, when a project is deleted the context becomes unavailable. |
contexts[].issueTypeId |
String | No |
The issue type ID of the context. Null is treated as a wildcard, meaning the UI modification will be applied to all issue types. Each UI modification context can have a maximum of one wildcard. |
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.