Jira.js - Jira Cloud API library
    Preparing search index...

    Interface PageOfStatuses

    interface PageOfStatuses {
        isLast?: boolean;
        maxResults?: number;
        nextPage?: string;
        self?: string;
        startAt?: number;
        total?: number;
        values?: {
            description: string;
            id: string;
            name: string;
            scope: { project?: { id: string }; type: "PROJECT" | "GLOBAL" };
            statusCategory: "TODO" | "IN_PROGRESS" | "DONE";
            usages?: { issueTypes?: string[]; project?: { id: string } };
        }[];
    }
    Index

    Properties

    isLast? maxResults? nextPage? self? startAt? total? values?

    Properties

    isLast?: boolean

    Whether this is the last page.

    maxResults?: number

    The maximum number of items that could be returned.

    nextPage?: string

    The URL of the next page of results, if any.

    self?: string

    The URL of this page.

    startAt?: number

    The index of the first item returned on the page.

    total?: number

    Number of items that satisfy the search.

    values?: {
        description: string;
        id: string;
        name: string;
        scope: { project?: { id: string }; type: "PROJECT" | "GLOBAL" };
        statusCategory: "TODO" | "IN_PROGRESS" | "DONE";
        usages?: { issueTypes?: string[]; project?: { id: string } };
    }[]

    The list of items.

    Type Declaration

    • description: string

      The description of the status.

    • id: string

      The ID of the status.

    • name: string

      The name of the status.

    • scope: { project?: { id: string }; type: "PROJECT" | "GLOBAL" }
      • Optionalproject?: { id: string }
        • id: string

          The ID of the project.

      • type: "PROJECT" | "GLOBAL"

        The scope of the status. GLOBAL for company-managed projects and PROJECT for team-managed projects.

    • statusCategory: "TODO" | "IN_PROGRESS" | "DONE"

      The category of the status.

    • Optionalusages?: { issueTypes?: string[]; project?: { id: string } }

      See the deprecation notice for details.

      Projects and issue types where the status is used. Only available if the usages expand is requested.

      • OptionalissueTypes?: string[]
      • Optionalproject?: { id: string }
        • id: string

          The ID of the project.

    Settings

    Member Visibility

    On This Page

    Properties