jira.js
    Preparing search index...

    Function findComponentsForProjects

    • Returns a paginated list of all components in a project, including global (Compass) components when applicable.

      This operation can be accessed anonymously.

      Permissions required: Browse Projects project permission for the project.

      Parameters

      • client: Client
      • Optionalparameters: {
            maxResults?: number;
            orderBy?:
                | "name"
                | "description"
                | string & {}
                | "-description"
                | "+description"
                | "-name"
                | "+name";
            projectIdsOrKeys?: string[];
            query?: string;
            startAt?: number;
        }
        • OptionalmaxResults?: number

          The maximum number of items to return per page.

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

          Order the results by a field:

          • description Sorts by the component description.
          • name Sorts by component name.
        • OptionalprojectIdsOrKeys?: string[]

          The project IDs and/or project keys (case sensitive).

        • Optionalquery?: string

          Filter the results using a literal string. Components with a matching name or description are returned (case insensitive).

        • 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: {
                  ari?: string;
                  description?: string;
                  id?: string;
                  metadata?: Record<string, any>;
                  name?: string;
                  self?: string;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility