jira.js
    Preparing search index...

    Function getUiModifications

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

      Parameters

      • client: Client
      • Optionalparameters: {
            expand?:
                | string
                | string[]
                | string & {}
                | ("data" | string & {} | "contexts")[];
            maxResults?: number;
            startAt?: number;
        }
        • Optionalexpand?: string | string[] | string & {} | ("data" | string & {} | "contexts")[]

          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.
        • OptionalmaxResults?: number

          The maximum number of items to return per page.

        • OptionalstartAt?: number

          The index of the first item to return in a page of results (page offset).

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              isLast: boolean;
              maxResults: number;
              nextPage?: string;
              self?: string;
              startAt: number;
              total: number;
              values: {
                  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;
                  id: string;
                  name: string;
                  self: string;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility