priorityscheme
create-priority-scheme
Create priority scheme
Creates a new priority scheme.
Permissions required: Administer Jira global permission.
POST /rest/api/3/priorityscheme
| Flag | Type | Required | Description |
|---|---|---|---|
--body | string | No | request body (JSON string, @file, or - for stdin) |
Example:
jr priorityscheme create-priority-schemedelete-priority-scheme
Delete priority scheme
Deletes a priority scheme.
This operation is only available for priority schemes without any associated projects. Any associated projects must be removed from the priority scheme before this operation can be performed.
Permissions required: Administer Jira global permission.
DELETE /rest/api/3/priorityscheme/{schemeId}
| Flag | Type | Required | Description |
|---|---|---|---|
--schemeId | string | Yes | The priority scheme ID. |
Example:
jr priorityscheme delete-priority-scheme --schemeId <schemeId>get-available-priorities-by-priority-scheme
Get available priorities by priority scheme
Returns a paginated list of priorities available for adding to a priority scheme.
Permissions required: Permission to access Jira.
GET /rest/api/3/priorityscheme/priorities/available
| Flag | Type | Required | Description |
|---|---|---|---|
--exclude | string | No | A list of priority IDs to exclude from the results. |
--maxResults | string | No | The maximum number of items to return per page. |
--query | string | No | The string to query priorities on by name. |
--schemeId | string | No | The priority scheme ID. |
--startAt | string | No | The index of the first item to return in a page of results (page offset). |
Example:
jr priorityscheme get-available-priorities-by-priority-schemeget-priorities-by-priority-scheme
Get priorities by priority scheme
Returns a paginated list of priorities by scheme.
Permissions required: Permission to access Jira.
GET /rest/api/3/priorityscheme/{schemeId}/priorities
| Flag | Type | Required | Description |
|---|---|---|---|
--maxResults | string | No | The maximum number of items to return per page. |
--schemeId | string | Yes | The priority scheme ID. |
--startAt | string | No | The index of the first item to return in a page of results (page offset). |
Example:
jr priorityscheme get-priorities-by-priority-scheme --schemeId <schemeId>get-priority-schemes
Get priority schemes
Returns a paginated list of priority schemes.
Permissions required: Permission to access Jira.
GET /rest/api/3/priorityscheme
| Flag | Type | Required | Description |
|---|---|---|---|
--expand | string | No | A comma separated list of additional information to return. "priorities" will return priorities associated with the priority scheme. "projects" will return projects associated with the priority scheme. expand=priorities,projects. |
--maxResults | string | No | The maximum number of items to return per page. |
--onlyDefault | string | No | Whether only the default priority is returned. |
--orderBy | string | No | The ordering to return the priority schemes by. |
--priorityId | string | No | A set of priority IDs to filter by. To include multiple IDs, provide an ampersand-separated list. For example, priorityId=10000&priorityId=10001. |
--schemeId | string | No | A set of priority scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, schemeId=10000&schemeId=10001. |
--schemeName | string | No | The name of scheme to search for. |
--startAt | string | No | The index of the first item to return in a page of results (page offset). |
Example:
jr priorityscheme get-priority-schemesget-projects-by-priority-scheme
Get projects by priority scheme
Returns a paginated list of projects by scheme.
Permissions required: Permission to access Jira.
GET /rest/api/3/priorityscheme/{schemeId}/projects
| Flag | Type | Required | Description |
|---|---|---|---|
--maxResults | string | No | The maximum number of items to return per page. |
--projectId | string | No | The project IDs to filter by. For example, projectId=10000&projectId=10001. |
--query | string | No | The string to query projects on by name. |
--schemeId | string | Yes | The priority scheme ID. |
--startAt | string | No | The index of the first item to return in a page of results (page offset). |
Example:
jr priorityscheme get-projects-by-priority-scheme --schemeId <schemeId>suggested-priorities-for-mappings
Suggested priorities for mappings
Returns a paginated list of priorities that would require mapping, given a change in priorities or projects associated with a priority scheme.
Permissions required: Permission to access Jira.
POST /rest/api/3/priorityscheme/mappings
| Flag | Type | Required | Description |
|---|---|---|---|
--body | string | No | request body (JSON string, @file, or - for stdin) |
Example:
jr priorityscheme suggested-priorities-for-mappingsupdate-priority-scheme
Update priority scheme
Updates a priority scheme. This includes its details, the lists of priorities and projects in it
Permissions required: Administer Jira global permission.
PUT /rest/api/3/priorityscheme/{schemeId}
| Flag | Type | Required | Description |
|---|---|---|---|
--body | string | No | request body (JSON string, @file, or - for stdin) |
--schemeId | string | Yes | The ID of the priority scheme. |
Example:
jr priorityscheme update-priority-scheme --schemeId <schemeId>