uiModifications

create-ui-modification

Create UI modification

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

Each app can define up to 3000 UI modifications. Each UI modification can define up to 1000 contexts. The same context can be assigned to maximum 100 UI modifications.

Context types:

• Jira contexts: For Jira view types, use projectId and issueTypeId. One field can act as a wildcard. Supported Jira views:

  • GIC - Jira global issue create
  • IssueView - Jira issue view
  • IssueTransition - Jira issue transition

• Jira Service Management contexts: For Jira Service Management view types, use portalId and requestTypeId. Wildcards are not supported. Supported JSM views:

  • JSMRequestCreate - Jira Service Management request create portal view

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.

POST /rest/api/3/uiModifications

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)

Example:

jr uiModifications create-ui-modification

delete-ui-modification

Delete UI modification

Deletes a UI modification. All the contexts that belong to the UI modification are deleted too. UI modification can only be deleted by Forge apps.

Permissions required: None.

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.

DELETE /rest/api/3/uiModifications/{uiModificationId}

Flag	Type	Required	Description
--uiModificationId	string	Yes	The ID of the UI modification.

Example:

jr uiModifications delete-ui-modification --uiModificationId <uiModificationId>

get-ui-modifications

Get UI modifications

Gets UI modifications. UI modifications can only be retrieved by Forge apps.

Permissions required: None.

The new read: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.

GET /rest/api/3/uiModifications

Flag	Type	Required	Description
--expand	string	No	Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

• data Returns UI modification data.
• contexts Returns UI modification contexts. | | --maxResults | string | No | The maximum number of items to return per page. | | --startAt | string | No | The index of the first item to return in a page of results (page offset). |

Example:

jr uiModifications get-ui-modifications

update-ui-modification

Update UI modification

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.

Context types:

• Jira contexts: For Jira view types, use projectId and issueTypeId. One field can act as a wildcard. Supported Jira views:

  • GIC - Jira global issue create
  • IssueView - Jira issue view
  • IssueTransition - Jira issue transition

• Jira Service Management contexts: For Jira Service Management view types, use portalId and requestTypeId. Wildcards are not supported. Supported JSM views:

  • JSMRequestCreate - Jira Service Management request create portal view

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.

PUT /rest/api/3/uiModifications/{uiModificationId}

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--uiModificationId	string	Yes	The ID of the UI modification.

Example:

jr uiModifications update-ui-modification --uiModificationId <uiModificationId>