jira.js
    Preparing search index...

    Function getScreens

    • Returns a paginated list of all screens or those specified by one or more screen IDs.

      Permissions required: Administer Jira global permission.

      Parameters

      • client: Client
      • Optionalparameters: {
            id?: number[];
            maxResults?: number;
            orderBy?: "name" | "id" | string & {} | "-name" | "+name" | "-id" | "+id";
            queryString?: string;
            scope?: (string & {} | "PROJECT" | "TEMPLATE" | "GLOBAL")[];
            startAt?: number;
        }
        • Optionalid?: number[]

          The list of screen IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.

        • OptionalmaxResults?: number

          The maximum number of items to return per page.

        • OptionalorderBy?: "name" | "id" | string & {} | "-name" | "+name" | "-id" | "+id"

          Order the results by a field:

          • id Sorts by screen ID.
          • name Sorts by screen name.
        • OptionalqueryString?: string

          String used to perform a case-insensitive partial match with screen name.

        • Optionalscope?: (string & {} | "PROJECT" | "TEMPLATE" | "GLOBAL")[]

          The scope filter string. To filter by multiple scope, provide an ampersand-separated list. For example, scope=GLOBAL&scope=PROJECT.

        • 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: {
                  description?: string;
                  id?: number;
                  name?: string;
                  scope?: {
                      project?: {
                          avatarUrls?: {
                              "16x16"?: (...)
                              | (...);
                              "24x24"?: (...) | (...);
                              "32x32"?: (...) | (...);
                              "48x48"?: (...) | (...);
                              [key: string]: unknown;
                          };
                          id?: string;
                          key?: string;
                          name?: string;
                          projectCategory?: {
                              description?: (...)
                              | (...);
                              id?: (...) | (...);
                              name?: (...) | (...);
                              self?: (...) | (...);
                              [key: string]: unknown;
                          };
                          projectTypeKey?: | string & {}
                          | "software"
                          | "service_desk"
                          | "business"
                          | "product_discovery"
                          | "customer_service";
                          self?: string;
                          simplified?: boolean;
                          [key: string]: unknown;
                      };
                      type?: string & {}
                      | "PROJECT"
                      | "TEMPLATE";
                      [key: string]: unknown;
                  };
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility