Skip to content

priorityscheme

create-priority-scheme

Create priority scheme

Creates a new priority scheme.

Permissions required: Administer Jira global permission.

POST /rest/api/3/priorityscheme

FlagTypeRequiredDescription
--bodystringNorequest body (JSON string, @file, or - for stdin)

Example:

bash
jr priorityscheme create-priority-scheme

delete-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}

FlagTypeRequiredDescription
--schemeIdstringYesThe priority scheme ID.

Example:

bash
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

FlagTypeRequiredDescription
--excludestringNoA list of priority IDs to exclude from the results.
--maxResultsstringNoThe maximum number of items to return per page.
--querystringNoThe string to query priorities on by name.
--schemeIdstringNoThe priority scheme ID.
--startAtstringNoThe index of the first item to return in a page of results (page offset).

Example:

bash
jr priorityscheme get-available-priorities-by-priority-scheme

get-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

FlagTypeRequiredDescription
--maxResultsstringNoThe maximum number of items to return per page.
--schemeIdstringYesThe priority scheme ID.
--startAtstringNoThe index of the first item to return in a page of results (page offset).

Example:

bash
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

FlagTypeRequiredDescription
--expandstringNoA 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.
--maxResultsstringNoThe maximum number of items to return per page.
--onlyDefaultstringNoWhether only the default priority is returned.
--orderBystringNoThe ordering to return the priority schemes by.
--priorityIdstringNoA set of priority IDs to filter by. To include multiple IDs, provide an ampersand-separated list. For example, priorityId=10000&priorityId=10001.
--schemeIdstringNoA set of priority scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, schemeId=10000&schemeId=10001.
--schemeNamestringNoThe name of scheme to search for.
--startAtstringNoThe index of the first item to return in a page of results (page offset).

Example:

bash
jr priorityscheme get-priority-schemes

get-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

FlagTypeRequiredDescription
--maxResultsstringNoThe maximum number of items to return per page.
--projectIdstringNoThe project IDs to filter by. For example, projectId=10000&projectId=10001.
--querystringNoThe string to query projects on by name.
--schemeIdstringYesThe priority scheme ID.
--startAtstringNoThe index of the first item to return in a page of results (page offset).

Example:

bash
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

FlagTypeRequiredDescription
--bodystringNorequest body (JSON string, @file, or - for stdin)

Example:

bash
jr priorityscheme suggested-priorities-for-mappings

update-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}

FlagTypeRequiredDescription
--bodystringNorequest body (JSON string, @file, or - for stdin)
--schemeIdstringYesThe ID of the priority scheme.

Example:

bash
jr priorityscheme update-priority-scheme --schemeId <schemeId>