UI modifications (apps)

Update UI modification

Changed on

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

  • Agent view contexts: For Agent view types, use projectId and issueTypeId like Jira contexts, and optionally set requestTypeId. portalId must not be set. One of projectId, issueTypeId, or viewType can act as a wildcard. Supported Agent views:

    • GICAgentView - Agent view variant of Jira global issue create
    • IssueViewAgentView - Agent view variant of Jira issue view
    • IssueTransitionAgentView - Agent view variant of Jira issue transition

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/2/uiModifications/{uiModificationId}

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/uiModifications/{uiModificationId}
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token, scopes: read:jira-work)

Path parameters

uiModificationIdstring required

The ID of the UI modification.

Request body

datastring

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

descriptionstring

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

namestring

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

Response

Returned if the UI modification is updated.

unknown required

Changes

  • f913c5e48b11Revision changes
    • info

      added the new GICAgentView enum value to the request property //

    • info

      added the new IssueTransitionAgentView enum value to the request property //

    • info

      added the new IssueViewAgentView enum value to the request property //