jira.js
    Preparing search index...

    Function getProjectComponents

    • Returns all components in a project. See the Get project components paginated resource if you want to get a full list of components with pagination.

      If your project uses Compass components, this API will return a paginated list of Compass components that are linked to issues in that project.

      This operation can be accessed anonymously.

      Permissions required: Browse Projects project permission for the project.

      Parameters

      • client: Client
      • parameters: {
            componentSource?: "auto" | "jira" | string & {} | "compass";
            projectIdOrKey: string;
        }
        • OptionalcomponentSource?: "auto" | "jira" | string & {} | "compass"

          The source of the components to return. Can be jira (default), compass or auto. When auto is specified, the API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira components. Defaults to jira.

        • projectIdOrKey: string

          The project ID or project key (case sensitive).

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              ari?: string;
              assignee?: {
                  accountId?: string;
                  accountType?: "unknown"
                  | string & {}
                  | "atlassian"
                  | "app"
                  | "customer";
                  active?: boolean;
                  applicationRoles?: {
                      callback?: { [key: string]: unknown };
                      items?: {
                          defaultGroups?: (...) | (...);
                          defaultGroupsDetails?: (...) | (...);
                          defined?: (...) | (...) | (...);
                          groupDetails?: (...) | (...);
                          groups?: (...) | (...);
                          hasUnlimitedSeats?: (...) | (...) | (...);
                          key?: (...) | (...);
                          name?: (...) | (...);
                          numberOfSeats?: (...) | (...);
                          platform?: (...) | (...) | (...);
                          remainingSeats?: (...) | (...);
                          selectedByDefault?: (...) | (...) | (...);
                          userCount?: (...) | (...);
                          userCountDescription?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      "max-results"?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  appType?: string;
                  avatarUrls?: {
                      "16x16"?: string;
                      "24x24"?: string;
                      "32x32"?: string;
                      "48x48"?: string;
                      [key: string]: unknown;
                  };
                  displayName?: string;
                  emailAddress?: string;
                  expand?: string;
                  groups?: {
                      callback?: { [key: string]: unknown };
                      items?: {
                          groupId?: (...) | (...) | (...);
                          name?: (...) | (...);
                          self?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      "max-results"?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  guest?: boolean;
                  locale?: string;
                  self?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              };
              assigneeType?: | string & {}
              | "PROJECT_DEFAULT"
              | "COMPONENT_LEAD"
              | "PROJECT_LEAD"
              | "UNASSIGNED";
              description?: string;
              id?: string;
              isAssigneeTypeValid?: boolean;
              lead?: {
                  accountId?: string;
                  accountType?: "unknown"
                  | string & {}
                  | "atlassian"
                  | "app"
                  | "customer";
                  active?: boolean;
                  applicationRoles?: {
                      callback?: { [key: string]: unknown };
                      items?: {
                          defaultGroups?: (...) | (...);
                          defaultGroupsDetails?: (...) | (...);
                          defined?: (...) | (...) | (...);
                          groupDetails?: (...) | (...);
                          groups?: (...) | (...);
                          hasUnlimitedSeats?: (...) | (...) | (...);
                          key?: (...) | (...);
                          name?: (...) | (...);
                          numberOfSeats?: (...) | (...);
                          platform?: (...) | (...) | (...);
                          remainingSeats?: (...) | (...);
                          selectedByDefault?: (...) | (...) | (...);
                          userCount?: (...) | (...);
                          userCountDescription?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      "max-results"?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  appType?: string;
                  avatarUrls?: {
                      "16x16"?: string;
                      "24x24"?: string;
                      "32x32"?: string;
                      "48x48"?: string;
                      [key: string]: unknown;
                  };
                  displayName?: string;
                  emailAddress?: string;
                  expand?: string;
                  groups?: {
                      callback?: { [key: string]: unknown };
                      items?: {
                          groupId?: (...) | (...) | (...);
                          name?: (...) | (...);
                          self?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      "max-results"?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  guest?: boolean;
                  locale?: string;
                  self?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              };
              leadAccountId?: string;
              metadata?: Record<string, any>;
              name?: string;
              project?: string;
              projectId?: number;
              realAssignee?: {
                  accountId?: string;
                  accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer";
                  active?: boolean;
                  applicationRoles?: {
                      callback?: { [key: string]: unknown };
                      items?: {
                          defaultGroups?: (...) | (...);
                          defaultGroupsDetails?: (...) | (...);
                          defined?: (...) | (...) | (...);
                          groupDetails?: (...) | (...);
                          groups?: (...) | (...);
                          hasUnlimitedSeats?: (...) | (...) | (...);
                          key?: (...) | (...);
                          name?: (...) | (...);
                          numberOfSeats?: (...) | (...);
                          platform?: (...) | (...) | (...);
                          remainingSeats?: (...) | (...);
                          selectedByDefault?: (...) | (...) | (...);
                          userCount?: (...) | (...);
                          userCountDescription?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      "max-results"?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  appType?: string;
                  avatarUrls?: {
                      "16x16"?: string;
                      "24x24"?: string;
                      "32x32"?: string;
                      "48x48"?: string;
                      [key: string]: unknown;
                  };
                  displayName?: string;
                  emailAddress?: string;
                  expand?: string;
                  groups?: {
                      callback?: { [key: string]: unknown };
                      items?: {
                          groupId?: (...) | (...) | (...);
                          name?: (...) | (...);
                          self?: (...) | (...);
                          [key: string]: unknown;
                      }[];
                      "max-results"?: number;
                      pagingCallback?: { [key: string]: unknown };
                      size?: number;
                      [key: string]: unknown;
                  };
                  guest?: boolean;
                  locale?: string;
                  self?: string;
                  timeZone?: string;
                  [key: string]: unknown;
              };
              realAssigneeType?: | string & {}
              | "PROJECT_DEFAULT"
              | "COMPONENT_LEAD"
              | "PROJECT_LEAD"
              | "UNASSIGNED";
              self?: string;
              [key: string]: unknown;
          }[],
      >

    Settings
    Member Visibility