statuses

create

Bulk create statuses

Creates statuses for a global or project scope.

Permissions required:

• Administer projects project permission.
• Administer Jira project permission.

POST /rest/api/3/statuses

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)

Example:

jr statuses create

delete-by-id

Bulk delete Statuses

Deletes statuses by ID.

Permissions required:

• Administer projects project permission.
• Administer Jira project permission.

DELETE /rest/api/3/statuses

Flag	Type	Required	Description
--id	string	No	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 |

Example:

jr statuses delete-by-id

get-by-id

Bulk get statuses

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

Permissions required:

• Administer projects project permission.
• Administer Jira project permission.

GET /rest/api/3/statuses

Flag	Type	Required	Description
--id	string	No	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 |

Example:

jr statuses get-by-id

get-by-name

Bulk get statuses by name

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.

GET /rest/api/3/statuses/byNames

Flag	Type	Required	Description
--name	string	No	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 | | --projectId | string | No | The project the status is part of or null for global statuses. |

Example:

jr statuses get-by-name

get-project-issue-type-usages-for

Get issue type usages by status and project

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

GET /rest/api/3/statuses/{statusId}/project/{projectId}/issueTypeUsages

Flag	Type	Required	Description
--maxResults	string	No	The maximum number of results to return. Must be an integer between 1 and 200.
--nextPageToken	string	No	The cursor for pagination
--projectId	string	Yes	The projectId to fetch issue type usages for
--statusId	string	Yes	The statusId to fetch issue type usages for

Example:

jr statuses get-project-issue-type-usages-for --projectId <projectId> --statusId <statusId>

get-project-usages-for

Get project usages by status

Returns a page of projects using a given status.

GET /rest/api/3/statuses/{statusId}/projectUsages

Flag	Type	Required	Description
--maxResults	string	No	The maximum number of results to return. Must be an integer between 1 and 200.
--nextPageToken	string	No	The cursor for pagination
--statusId	string	Yes	The statusId to fetch project usages for

Example:

jr statuses get-project-usages-for --statusId <statusId>

get-workflow-usages-for

Get workflow usages by status

Returns a page of workflows using a given status.

GET /rest/api/3/statuses/{statusId}/workflowUsages

Flag	Type	Required	Description
--maxResults	string	No	The maximum number of results to return. Must be an integer between 1 and 200.
--nextPageToken	string	No	The cursor for pagination
--statusId	string	Yes	The statusId to fetch workflow usages for

Example:

jr statuses get-workflow-usages-for --statusId <statusId>

search

Search statuses paginated

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

Permissions required:

• Administer projects project permission.
• Administer Jira project permission.

GET /rest/api/3/statuses/search

Flag	Type	Required	Description
--maxResults	string	No	The maximum number of items to return per page.
--projectId	string	No	The project the status is part of or null for global statuses.
--searchString	string	No	Term to match status names against or null to search for all statuses in the search scope.
--startAt	string	No	The index of the first item to return in a page of results (page offset).
--statusCategory	string	No	Category of the status to filter by. The supported values are: TODO, IN_PROGRESS, and DONE.

Example:

jr statuses search

update

Bulk update statuses

Updates statuses by ID.

Permissions required:

• Administer projects project permission.
• Administer Jira project permission.

PUT /rest/api/3/statuses

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)

Example:

jr statuses update