--- title: "Update priority scheme" method: PUT path: "/rest/api/3/priorityscheme/{schemeId}" tags: ["Priority schemes"] --- # Update priority scheme `PUT /rest/api/3/priorityscheme/{schemeId}` Updates a priority scheme. This includes its details, the lists of priorities and projects in it **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). ## Path parameters - `schemeId` integer, required ## Request body - UpdatePrioritySchemeRequestBean — Details of a priority scheme. - `defaultPriorityId` integer — The default priority of the scheme. - `description` string — The description of the priority scheme. - `mappings` PriorityMapping — Mapping of issue priorities for changes in priority schemes. - `in` object — The mapping of priorities for issues being migrated **into** this priority scheme. Key is the old priority ID, value is the new priority ID (must exist in this priority scheme). E.g. The current priority scheme has priority ID `10001`. Issues with priority ID `10000` are being migrated into this priority scheme will need mapping to new priorities. The `in` mapping would be `{"10000": 10001}`. - `out` object — The mapping of priorities for issues being migrated **out of** this priority scheme. Key is the old priority ID (must exist in this priority scheme), value is the new priority ID (must exist in the default priority scheme). Required for updating an existing priority scheme. Not used when creating a new priority scheme. E.g. The current priority scheme has priority ID `10001`. Issues with priority ID `10001` are being migrated out of this priority scheme will need mapping to new priorities. The `out` mapping would be `{"10001": 10000}`. - `name` string — The name of the priority scheme. Must be unique. - `priorities` UpdatePrioritiesInSchemeRequestBean — Update priorities in a scheme - `add` PrioritySchemeChangesWithoutMappings - `ids` integer[], required — Affected entity ids. - `remove` PrioritySchemeChangesWithoutMappings - `ids` integer[], required — Affected entity ids. - `projects` UpdateProjectsInSchemeRequestBean — Update projects in a scheme - `add` PrioritySchemeChangesWithoutMappings - `ids` integer[], required — Affected entity ids. - `remove` PrioritySchemeChangesWithoutMappings - `ids` integer[], required — Affected entity ids. ## Response `202` Returned if the request is accepted. - UpdatePrioritySchemeResponseBean — Details of the updated priority scheme. - `priorityScheme` PrioritySchemeWithPaginatedPrioritiesAndProjects — A priority scheme with paginated priorities and projects. - `default` boolean - `defaultPriorityId` string — The ID of the default issue priority. - `description` string — The description of the priority scheme - `id` string, required — The ID of the priority scheme. - `isDefault` boolean - `name` string, required — The name of the priority scheme - `priorities` PageBeanPriorityWithSequence — A page of items. - `isLast` boolean — Whether this is the last page. - `maxResults` integer — The maximum number of items that could be returned. - `nextPage` string, uri — If there is another page of results, the URL of the next page. - `self` string, uri — The URL of the page. - `startAt` integer — The index of the first item returned. - `total` integer — The number of items returned. - `values` PriorityWithSequence[] — The list of items. - `description` string — The description of the issue priority. - `iconUrl` string — The URL of the icon for the issue priority. - `id` string — The ID of the issue priority. - `isDefault` boolean — Whether this priority is the default. - `name` string — The name of the issue priority. - `self` string — The URL of the issue priority. - `sequence` string — The sequence of the issue priority. - `statusColor` string — The color used to indicate the issue priority. - `projects` PageBeanProjectDetails — A page of items. - `isLast` boolean — Whether this is the last page. - `maxResults` integer — The maximum number of items that could be returned. - `nextPage` string, uri — If there is another page of results, the URL of the next page. - `self` string, uri — The URL of the page. - `startAt` integer — The index of the first item returned. - `total` integer — The number of items returned. - `values` ProjectDetails[] — The list of items. - `avatarUrls` AvatarUrlsBean - `16x16` string, uri — The URL of the item's 16x16 pixel avatar. - `24x24` string, uri — The URL of the item's 24x24 pixel avatar. - `32x32` string, uri — The URL of the item's 32x32 pixel avatar. - `48x48` string, uri — The URL of the item's 48x48 pixel avatar. - `id` string — The ID of the project. - `key` string — The key of the project. - `name` string — The name of the project. - `projectCategory` UpdatedProjectCategory — A project category. - `description` string — The name of the project category. - `id` string — The ID of the project category. - `name` string — The description of the project category. - `self` string — The URL of the project category. - `projectTypeKey` 'software' | 'service_desk' | 'business' — The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project. - `self` string — The URL of the project details. - `simplified` boolean — Whether or not the project is simplified. - `self` string — The URL of the priority scheme. - `task` TaskProgressBeanJsonNode — Details about a task. - `description` string — The description of the task. - `elapsedRuntime` integer, required — The execution time of the task, in milliseconds. - `finished` integer — A timestamp recording when the task was finished. - `id` string, required — The ID of the task. - `lastUpdate` integer, required — A timestamp recording when the task progress was last updated. - `message` string — Information about the progress of the task. - `progress` integer, required — The progress of the task, as a percentage complete. - `result` JsonNode - `array` boolean - `bigDecimal` boolean - `bigInteger` boolean - `bigIntegerValue` integer - `binary` boolean - `binaryValue` string[] - `boolean` boolean - `booleanValue` boolean - `containerNode` boolean - `decimalValue` number - `double` boolean - `doubleValue` number, double - `elements` object - `fieldNames` object - `fields` object - `floatingPointNumber` boolean - `int` boolean - `intValue` integer - `integralNumber` boolean - `long` boolean - `longValue` integer - `missingNode` boolean - `null` boolean - `number` boolean - `numberType` 'INT' | 'LONG' | 'BIG_INTEGER' | 'FLOAT' | 'DOUBLE' | 'BIG_DECIMAL' - `numberValue` number - `object` boolean - `pojo` boolean - `textValue` string - `textual` boolean - `valueAsBoolean` boolean - `valueAsDouble` number, double - `valueAsInt` integer - `valueAsLong` integer - `valueAsText` string - `valueNode` boolean - `self` string, uri, required — The URL of the task. - `started` integer — A timestamp recording when the task was started. - `status` 'ENQUEUED' | 'RUNNING' | 'COMPLETE' | 'FAILED' | 'CANCEL_REQUESTED' | 'CANCELLED' | 'DEAD', required — The status of the task. - `submitted` integer, required — A timestamp recording when the task was submitted. - `submittedBy` integer, required — The ID of the user who submitted the task. ## Other responses - `400` — Returned if the request isn't valid. **Mappings Validation Errors** * ``The changes to priority schemes require mapping of priorities. Please provide a value for the 'in' mappings object.`` Priorities are being removed and/or projects are being added to the scheme, but ``in`` mappings are not provided. * ``The changes to priority schemes require mapping of priorities. Please provide a value for the 'out' mappings object.`` Projects are being removed from the scheme, but ``out`` mappings are not provided. * ``The priorities with IDs [ID 1, ID 2, ...] provided as keys for the 'in' mappings object do not exist. Please provide existing priority IDs.`` The listed priority ID(s) have been provided as keys for ``in`` mappings but do not exist. Please confirm the correct priority ID(s) have been provided, they should be priorities that exist on the Jira site which are used by projects being added to the current scheme, but are not in use by the current scheme. * ``The priorities with IDs [ID 1, ID 2, ...] provided as values for the 'in' mappings object do not exist. Please provide existing priority IDs used by the current priority scheme.`` The listed priority ID(s) have been provided as values for ``in`` mappings but do not exist. Please confirm the correct priority ID(s) have been provided, they should be priorities that exist on the Jira site and are in use by the current scheme. * ``The priorities with IDs [ID 1, ID 2, ...] provided as keys for the 'out' mappings object do not exist. Please provide existing priority IDs used by the current priority scheme.`` The listed priority ID(s) have been provided as keys for ``out`` mappings but are invalid. Please confirm the correct priority ID(s) have been provided, they should be priorities that exist on the Jira site and are in use by the current scheme. * ``The priorities with IDs [ID 1, ID 2, ...] provided as values for the 'out' mappings object do not exist. Please provide existing priority IDs used by the default scheme.`` The listed priority ID(s) have been provided as values for ``out`` mappings but are invalid. Please confirm the correct priority ID(s) have been provided, they should be priorities that exist on the Jira site and are in use by the Default Priority Scheme, but are not in use by the current scheme. * ``The priorities with IDs [ID 1, ID 2, ...] do not require mapping. Please remove these keys and their corresponding values from the 'in' mappings object.`` The listed priority ID(s) have been provided as keys for ``in`` mappings but are not required, they can be removed from the mappings object. * ``The priorities with IDs [ID 1, ID 2, ...] require mapping. Please provide mappings in the 'in' mappings object, where these priorities are the keys with corresponding values.`` The listed priority ID(s) have not been provided as keys for ``in`` mappings but are required, add them to the mappings object. * ``The priorities with IDs [ID 1, ID 2, ...] being mapped to are not in the current scheme. Please remove these values and their corresponding keys from the 'in' mappings object.`` The listed priority ID(s) have been provided as keys for ``in`` mappings but are not in use by the current scheme, they can be removed from the mappings object. * ``The priorities with IDs [ID 1, ID 2, ...] do not require mapping. Please remove these keys and their corresponding values from the 'out' mappings object.`` The listed priority ID(s) hve been provided as keys for ``out`` mappings but are not required, they can be removed from the mappings object. * ``The priorities with IDs [ID 1, ID 2, ...] require mapping. Please provide mappings in the 'out' mappings object, where these priorities are the keys with corresponding values.`` The listed priority ID(s) have not been provided as keys for ``out`` mappings but are required, add them to the mappings object. * ``The priorities with IDs [ID 1, ID 2, ...] being mapped to are not in the default scheme. Please remove these values and their corresponding keys from the 'out' mappings object.`` The listed priority ID(s) have been provided as keys for ``out`` mappings but are not in use by the Default Priority Scheme, they can be removed from the mappings object. - `401` — Returned if the authentication credentials are incorrect or missing. - `403` — Returned if the user doesn't have the necessary permissions. - `409` — Returned if an action with this priority scheme is still in progress. --- [API](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api-2.md) · [All operations](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-jira-cloud-platform-rest-api-2/versions/5a51740d7ab3/schema)