Create UI modification

Creates a UI modification. UI modification can only be created by Forge apps.

Each app can define up to 100 UI modifications. Each UI modification can define up to 1000 contexts.

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.

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/uiModifications' \ --header 'Content-Type: application/json' \ --data-raw '{ "contexts": [ { "issueTypeId": "10000", "projectId": "10000", "viewType": "GIC" }, { "issueTypeId": "10001", "projectId": "10000", "viewType": "GIC" } ], "data": "{field: '\''Story Points'\'', config: {hidden: false}}", "description": "Reveals Story Points field when any Sprint is selected.", "name": "Reveal Story Points" }'

Request

Body Params application/json

The details of a UI modification.

contexts

array[object (UiModificationContextDetails) {3}]

write-onlyoptional

List of contexts of the UI modification. The maximum number of contexts is 1000.

issueTypeId

string

required

The issue type ID of the context.

projectId

string

required

The project ID of the context.

viewType

string

required

The view type of the context. Only GIC (Global Issue Create) is supported.

data

string

write-onlyoptional

The data of the UI modification. The maximum size of the data is 50000 characters.

description

string

write-onlyoptional

The description of the UI modification. The maximum length is 255 characters.

name

string

write-onlyrequired

The name of the UI modification. The maximum length is 255 characters.

Examples

Responses

🟢201Returned if the UI modification is created.

application/json

Body

Identifiers for a UI modification.

string

read-onlyrequired

The ID of the UI modification.

self

string

read-onlyrequired

The URL of the UI modification.

🟠400Returned if the request is not valid.

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

🟠403Returned if the request is not from a Forge app.

🟠404Returned if a project or an issue type in the context are not found.