jira.js
    Preparing search index...

    Function updateUiModification

    • 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.

      Parameters

      • client: Client
      • parameters: {
            contexts?: {
                id?: string;
                isAvailable?: boolean;
                issueTypeId?: string;
                portalId?: string;
                projectId?: string;
                requestTypeId?: string;
                viewType?:
                    | string & {}
                    | "GIC"
                    | "IssueView"
                    | "IssueTransition"
                    | "JSMRequestCreate"
                    | "GICAgentView"
                    | "IssueViewAgentView"
                    | "IssueTransitionAgentView";
                [key: string]: unknown;
            }[];
            data?: string;
            description?: string;
            name?: string;
            uiModificationId: string;
        }
        • Optionalcontexts?: {
              id?: string;
              isAvailable?: boolean;
              issueTypeId?: string;
              portalId?: string;
              projectId?: string;
              requestTypeId?: string;
              viewType?:
                  | string & {}
                  | "GIC"
                  | "IssueView"
                  | "IssueTransition"
                  | "JSMRequestCreate"
                  | "GICAgentView"
                  | "IssueViewAgentView"
                  | "IssueTransitionAgentView";
              [key: string]: unknown;
          }[]

          List of contexts of the UI modification. The maximum number of contexts is 1000. If provided, replaces all existing contexts.

        • Optionaldata?: string

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

        • Optionaldescription?: string

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

        • Optionalname?: string

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

        • uiModificationId: string

          The ID of the UI modification.

      • Optionaloptions: RequestOptions

      Returns Promise<void>

    Settings
    Member Visibility