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

Index

Constructors

constructor

Methods

createStatuses deleteStatusesById getProjectIssueTypeUsagesForStatus getProjectUsagesForStatus getStatusesById getStatusesByName 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
Inherited from CommonHttpService.constructor

Methods

createStatuses

createStatuses(params): Promise<JiraStatus[]>
Creates statuses for a global or project scope.

Permissions required:
- Administer projects project permission.
- Administer Jira project permission.
Parameters
- params: {
  statusCreateRequest: StatusCreateRequest;
  }
  - statusCreateRequest: StatusCreateRequest
    Details of the statuses being created and their scope.
    Example
    { "scope": { "project": { "id": "1" }, "type": "PROJECT" }, "statuses": [ { "description": "The issue is resolved", "name": "Finished", "statusCategory": "DONE" } ] }
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"
  }
]
```
Path
POST /rest/api/3/statuses @scopes-current manage:jira-configuration @scopes-beta write:workflow:jira

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

deleteStatusesById

deleteStatusesById(params): Promise<void>
Deletes statuses by ID.

Permissions required:
- Administer projects project permission.
- Administer Jira project permission.
Parameters
- params: {
  id: string[];
  }
  - 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<void>
Returned if the request is successful.

Path
DELETE /rest/api/3/statuses @scopes-current manage:jira-configuration @scopes-beta write:workflow:jira

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

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:
- Administer projects project permission.
- Administer Jira project permission.
Parameters
- params: {
  id: string[];
  }
  - 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"
  }
]
```
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

getStatusesByName

getStatusesByName(params): Promise<JiraStatus[]>
Returns a list of the statuses specified by one or more status names.

Permissions required:
- Administer projects project permission.
- Administer Jira project permission.
- Browse projects project permission.
Parameters
- params: {
  name: string[];
  projectId?: string;
  }
  - name: string[]
    The list of status names. To include multiple names, provide an ampersand-separated list. For example, name=nameXX&name=nameYY.
    
    Min items 1, Max items 50
  - OptionalprojectId?: string
    The project the status is part of or null for global statuses.
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"
  }
]
```
Path
GET /rest/api/3/statuses/byNames @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-bynames-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:
- Administer projects project permission.
- Administer Jira project permission.
Parameters
- params: {
      maxResults?: number;
      projectId?: string;
      searchString?: string;
      startAt?: number;
      statusCategory?: string;
  } = {}
  - 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"
    }
  ]
}
```
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

updateStatuses(params): Promise<void>
Updates statuses by ID.

Permissions required:
- Administer projects project permission.
- Administer Jira project permission.
Parameters
- params: {
  statusUpdateRequest: StatusUpdateRequest;
  }
  - statusUpdateRequest: StatusUpdateRequest
    The list of statuses that will be updated.
    Example
    { "statuses": [ { "description": "The issue is resolved", "id": "1000", "name": "Finished", "statusCategory": "DONE" } ] }
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/statuses @scopes-current manage:jira-configuration @scopes-beta write:workflow:jira

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

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class StatusService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns StatusService

Methods

createStatuses

Parameters

statusCreateRequest: StatusCreateRequest

Example

Returns Promise<JiraStatus[]>

Path

See

deleteStatusesById

Parameters

id: string[]

Returns Promise<void>

Path

See

getProjectIssueTypeUsagesForStatus

Parameters

OptionalmaxResults?: number

OptionalnextPageToken?: string

projectId: string

statusId: string

Returns Promise<StatusProjectIssueTypeUsageDto>

Path

See

getProjectUsagesForStatus

Parameters

OptionalmaxResults?: number

OptionalnextPageToken?: string

statusId: string

Returns Promise<StatusProjectUsageDto>

Path

See

getStatusesById

Parameters

id: string[]

Returns Promise<JiraStatus[]>

Path

See

getStatusesByName

Parameters

name: string[]

OptionalprojectId?: string

Returns Promise<JiraStatus[]>

Path

See

getWorkflowUsagesForStatus

Parameters

OptionalmaxResults?: number

OptionalnextPageToken?: string

statusId: string

Returns Promise<StatusWorkflowUsageDto>

Path

See

search

Parameters

OptionalmaxResults?: number

OptionalprojectId?: string

OptionalsearchString?: string

OptionalstartAt?: number

OptionalstatusCategory?: string

Returns Promise<PageOfStatuses>

Path

See

updateStatuses

Parameters

statusUpdateRequest: StatusUpdateRequest

Example

Returns Promise<void>

Path

See

`Optional`maxResults?: number

`Optional`nextPageToken?: string

`Optional`maxResults?: number

`Optional`nextPageToken?: string

`Optional`projectId?: string

`Optional`maxResults?: number

`Optional`nextPageToken?: string

`Optional`maxResults?: number

`Optional`projectId?: string

`Optional`searchString?: string

`Optional`startAt?: number

`Optional`statusCategory?: string

`Protected` `Static`initialize