Class StatusService

This resource represents statuses. Use it to search, get, create, delete, and change statuses.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-status

Hierarchy

  • CommonHttpService
    • StatusService

Constructors

constructor

Methods

createStatuses deleteStatusesById getProjectIssueTypeUsagesForStatus getProjectUsagesForStatus getStatusesById getWorkflowUsagesForStatus search updateStatuses initialize

Constructors

constructor

  • new StatusService(getClientInstance): StatusService
  • Internal

    Create a new instance of the service.

    Parameters

    • getClientInstance: (() => CommonHttpClient)
        • (): CommonHttpClient

        • Returns CommonHttpClient

    Returns StatusService

Methods

createStatuses

deleteStatusesById

getProjectIssueTypeUsagesForStatus

  • getProjectIssueTypeUsagesForStatus(params): Promise<StatusProjectIssueTypeUsageDto>

  • Returns a page of issue types in a project using a given status.

    Parameters

    • params: {
          maxResults?: number;
          nextPageToken?: string;
          projectId: string;
          statusId: string;
      }
      • OptionalmaxResults?: number

        The maximum number of results to return. Must be an integer between 1 and 200.

      • OptionalnextPageToken?: string

        The cursor for pagination

      • projectId: string

        The projectId to fetch issue type usages for

      • statusId: string

        The statusId to fetch issue type usages for

    Returns Promise<StatusProjectIssueTypeUsageDto>

    Returned if the request is successful.

    example:

    {
      "issueTypes": {
        "nextPageToken": "eyJvIjoyfQ==",
        "values": [
          {
            "id": "1000"
          }
        ]
      },
      "projectId": "2000",
      "statusId": "1000"
    }

    Path

    GET /rest/api/3/statuses/{statusId}/project/{projectId}/issueTypeUsages @scopes-current manage:jira-configuration @scopes-beta read:project:jira, read:status:jira, read:issue-type:jira

    See

    https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-status#api-rest-api-3-statuses-statusid-project-projectid-issuetypeusages-get

getProjectUsagesForStatus

  • getProjectUsagesForStatus(params): Promise<StatusProjectUsageDto>

  • Returns a page of projects using a given status.

    Parameters

    • params: {
          maxResults?: number;
          nextPageToken?: string;
          statusId: string;
      }
      • OptionalmaxResults?: number

        The maximum number of results to return. Must be an integer between 1 and 200.

      • OptionalnextPageToken?: string

        The cursor for pagination

      • statusId: string

        The statusId to fetch project usages for

    Returns Promise<StatusProjectUsageDto>

    Returned if the request is successful.

    example:

    {
      "projects": {
        "nextPageToken": "eyJvIjoyfQ==",
        "values": [
          {
            "id": "1000"
          }
        ]
      },
      "statusId": "1000"
    }

    Path

    GET /rest/api/3/statuses/{statusId}/projectUsages @scopes-current manage:jira-configuration @scopes-beta read:project:jira, read:status:jira

    See

    https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-status#api-rest-api-3-statuses-statusid-projectusages-get

getStatusesById

  • getStatusesById(params): Promise<JiraStatus[]>

  • Returns a list of the statuses specified by one or more status IDs.

    Permissions required:

    Parameters

    • params: {
          expand?: string;
          id: string[];
      }
      • Optionalexpand?: string

        Deprecated. See the deprecation notice for details.

        Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

        • usages Returns the project and issue types that use the status in their workflow.
        • workflowUsages Returns the workflows that use the status.
      • id: string[]

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

        Min items 1, Max items 50

    Returns Promise<JiraStatus[]>

    Returned if the request is successful.

    example:

    [
      {
        "description": "The issue is resolved",
        "id": "1000",
        "name": "Finished",
        "scope": {
          "project": {
            "id": "1"
          },
          "type": "PROJECT"
        },
        "statusCategory": "DONE",
        "usages": [
          {
            "issueTypes": [
              "10002"
            ],
            "project": {
              "id": "1"
            }
          }
        ],
        "workflowUsages": [
          {
            "workflowId": "545d80a3-91ff-4949-8b0d-a2bc484e70e5",
            "workflowName": "Workflow 1"
          }
        ]
      }
    ]

    Path

    GET /rest/api/3/statuses @scopes-current manage:jira-configuration @scopes-beta read:workflow:jira

    See

    https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-status#api-rest-api-3-statuses-get

getWorkflowUsagesForStatus

  • getWorkflowUsagesForStatus(params): Promise<StatusWorkflowUsageDto>

  • Returns a page of workflows using a given status.

    Parameters

    • params: {
          maxResults?: number;
          nextPageToken?: string;
          statusId: string;
      }
      • OptionalmaxResults?: number

        The maximum number of results to return. Must be an integer between 1 and 200.

      • OptionalnextPageToken?: string

        The cursor for pagination

      • statusId: string

        The statusId to fetch workflow usages for

    Returns Promise<StatusWorkflowUsageDto>

    Returned if the request is successful.

    example:

    {
      "statusId": "1000",
      "workflows": {
        "nextPageToken": "eyJvIjoyfQ==",
        "values": [
          {
            "id": "545d80a3-91ff-4949-8b0d-a2bc484e70e5"
          }
        ]
      }
    }

    Path

    GET /rest/api/3/statuses/{statusId}/workflowUsages @scopes-current manage:jira-configuration @scopes-beta read:workflow:jira, read:status:jira

    See

    https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-status#api-rest-api-3-statuses-statusid-workflowusages-get

search

  • search(params?): Promise<PageOfStatuses>

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

    Permissions required:

    Parameters

    • params: {
          expand?: string;
          maxResults?: number;
          projectId?: string;
          searchString?: string;
          startAt?: number;
          statusCategory?: string;
      } = {}
      • Optionalexpand?: string

        Deprecated. See the deprecation notice for details.

        Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

        • usages Returns the project and issue types that use the status in their workflow.
        • workflowUsages Returns the workflows that use the status.
      • 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.

    Returns Promise<PageOfStatuses>

    Returned if the request is successful.

    example:

    {
      "isLast": true,
      "maxResults": 2,
      "nextPage": "https://your-domain.atlassian.net/rest/api/3/statuses/search?startAt=2&maxResults=2",
      "self": "https://your-domain.atlassian.net/rest/api/3/statuses/search?startAt=0&maxResults=2",
      "startAt": 0,
      "total": 5,
      "values": [
        {
          "description": "The issue is resolved",
          "id": "1000",
          "name": "Finished",
          "scope": {
            "project": {
              "id": "1"
            },
            "type": "PROJECT"
          },
          "statusCategory": "DONE",
          "usages": [
            {
              "issueTypes": [
                "10002"
              ],
              "project": {
                "id": "1"
              }
            }
          ],
          "workflowUsages": [
            {
              "workflowId": "545d80a3-91ff-4949-8b0d-a2bc484e70e5",
              "workflowName": "Workflow 1"
            }
          ]
        }
      ]
    }

    Path

    GET /rest/api/3/statuses/search @scopes-current manage:jira-configuration @scopes-beta read:workflow:jira

    See

    https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-status#api-rest-api-3-statuses-search-get

updateStatuses

Protected Staticinitialize

  • initialize(): void

  • Method to initialize the class. Normally used to set up validation rules.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods