jira.js
    Preparing search index...

    Function search

    • Returns a paginated list of statuses that match a search on name or project.

      Permissions required:

      Parameters

      • client: Client
      • Optionalparameters: {
            includeGlobalStatuses?: boolean;
            maxResults?: number;
            projectId?: string;
            searchString?: string;
            startAt?: number;
            statusCategory?: string;
        }
        • OptionalincludeGlobalStatuses?: boolean

          Whether to include global statuses (scope = null, not tied to any project) in the response. Defaults to false. Only relevant for project scoped queries.

        • OptionalmaxResults?: number

          The maximum number of items to return per page.

        • OptionalprojectId?: string

          The project the status is part of or null for global statuses.

        • OptionalsearchString?: string

          Term to match status names against or null to search for all statuses in the search scope.

        • OptionalstartAt?: number

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

        • OptionalstatusCategory?: string

          Category of the status to filter by. The supported values are: TODO, IN_PROGRESS, and DONE.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              isLast?: boolean;
              maxResults?: number;
              nextPage?: string;
              self?: string;
              startAt?: number;
              total?: number;
              values?: {
                  description?: string;
                  id?: string;
                  name?: string;
                  scope?: {
                      project?: { id: string; [key: string]: unknown };
                      type: string & {} | "PROJECT" | "GLOBAL";
                      [key: string]: unknown;
                  };
                  statusCategory?: string & {}
                  | "TODO"
                  | "IN_PROGRESS"
                  | "DONE";
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility