This resource represents issue workflow statuses. Use it to obtain a list of all statuses associated with workflows and the details of a status.

Hierarchy

  • CommonHttpService
    • WorkflowStatusesService

Constructors

  • Internal

    Create a new instance of the service.

    Parameters

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

    Returns WorkflowStatusesService

Methods

  • Returns a status. The status must be associated with an active workflow to be returned.

    If a name is used on more than one status, only the status found first is returned. Therefore, identifying the status by its ID may be preferable.

    This operation can be accessed anonymously.

    Permissions required: None.

    Parameters

    • params: {
          idOrName: string;
      }
      • idOrName: string

        The ID or name of the status.

    Returns Promise<StatusDetails>

    Returned if the request is successful.

    example:

    {
    "description": "The issue is currently being worked on.",
    "iconUrl": "https://your-domain.atlassian.net/images/icons/progress.gif",
    "id": "10000",
    "name": "In Progress",
    "self": "https://your-domain.atlassian.net/rest/api/3/status/10000",
    "statusCategory": {
    "colorName": "yellow",
    "id": 1,
    "key": "in-flight",
    "name": "In Progress",
    "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/1"
    }
    }

    GET /rest/api/3/status/{idOrName} @scopes-current read:jira-work @scopes-beta read:status:jira

  • Returns a list of all statuses associated with active workflows.

    This operation can be accessed anonymously.

    Permissions required: None.

    Returns Promise<StatusDetails[]>

    Returned if the request is successful.

    example:

    [
    {
    "description": "The issue is currently being worked on.",
    "iconUrl": "https://your-domain.atlassian.net/images/icons/progress.gif",
    "id": "10000",
    "name": "In Progress",
    "self": "https://your-domain.atlassian.net/rest/api/3/status/10000",
    "statusCategory": {
    "colorName": "yellow",
    "id": 1,
    "key": "in-flight",
    "name": "In Progress",
    "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/1"
    }
    },
    {
    "description": "The issue is closed.",
    "iconUrl": "https://your-domain.atlassian.net/images/icons/closed.gif",
    "id": "5",
    "name": "Closed",
    "self": "https://your-domain.atlassian.net/rest/api/3/status/5",
    "statusCategory": {
    "colorName": "green",
    "id": 9,
    "key": "completed",
    "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/9"
    }
    }
    ]

    GET /rest/api/3/status @scopes-current read:jira-work @scopes-beta read:status:jira

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

    Returns void