Atlassian: Update priority scheme

← Priority schemes operations · Get started

Operation atlassian.updatepriorityscheme

Provider route: PUT /{cloudId}/rest/api/3/priorityscheme/{schemeId}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["prioritySchemes"]["updatePriorityScheme"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.prioritySchemes.updatePriorityScheme(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.priority_schemes.update_priority_scheme(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.cloudId	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
path.schemeId	integer	Required within parent	Format: int64
body	Model	Required within parent	Expand Update priority scheme — request body — body

Referenced models: Update priority scheme — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Update priority scheme — response body

Referenced models: Update priority scheme — response body

Schemas

7 more schemas are linked from the tables above, on the schema pages.

Update priority scheme — response body

Field	Type	Presence	Description and constraints
$	object	Root	Details of the updated priority scheme. Additional keys: allowed
priorityScheme	JSON	Optional
priorityScheme (anyOf 1)	Model	Alternative	Expand Update priority scheme — response body — priority Scheme default, default Priority Id, description, id, is Default, name, priorities, projects, self
priorityScheme (anyOf 2)	null	Alternative
task	JSON	Optional
task (anyOf 1)	Model	Alternative	Expand Update priority scheme — response body — task Details about a task The in-progress issue migration task. Read only: true
task (anyOf 2)	null	Alternative

Referenced models: Update priority scheme — response body — priority Scheme default, default Priority Id, description, id, is Default, name, priorities, projects, self, Update priority scheme — response body — task Details about a task

Update priority scheme — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Details of a priority scheme. Additional keys: not allowed
defaultPriorityId	integer	Optional	The default priority of the scheme. Format: int64 write Only: true
description	string	Optional	The description of the priority scheme. Maximum length: 4000 write Only: true
mappings	Model	Optional	Expand Create priority scheme — request body — body mappings Instructions to migrate the priorities of issues. `in` mappings are used to migrate the priorities of issues to priorities used within the priority scheme. `out` mappings are used to migrate the priorities of issues to priorities not used within the priority scheme. * When **priorities** are **added** to the priority scheme, no mapping needs to be provided as the new priorities are not used by any issues. * When **priorities** are **removed** from the priority scheme, issues that are using those priorities must be migrated to new priorities used by the priority scheme. * An `in` mapping must be provided for each of these priorities. * When **projects** are **added** to the priority scheme, the priorities of issues in those projects might need to be migrated to new priorities used by the priority scheme. This can occur when the current scheme does not use all the priorities in the project(s)' priority scheme(s). * An `in` mapping must be provided for each of these priorities. * When **projects** are **removed** from the priority scheme, the priorities of issues in those projects might need to be migrated to new priorities within the **Default Priority Scheme** that are not used by the priority scheme. This can occur when the **Default Priority Scheme** does not use all the priorities within the current scheme. * An `out` mapping must be provided for each of these priorities. For more information on `in` and `out` mappings, see the child properties documentation for the `PriorityMapping` object below.
name	string	Optional	The name of the priority scheme. Must be unique. Maximum length: 255 write Only: true
priorities	Model	Optional	Expand Update priority scheme — request body — body priorities The priorities in the scheme.
projects	Model	Optional	Expand Update priority scheme — request body — body projects The projects in the scheme.

Referenced models: Create priority scheme — request body — body mappings, Update priority scheme — request body — body priorities, Update priority scheme — request body — body projects

Update priority scheme — response body — priority Scheme default, default Priority Id, description, id, is Default, name, priorities, projects, self

Field	Type	Presence	Description and constraints
$	object	Root	A priority scheme with paginated priorities and projects. Additional keys: allowed
default	JSON	Optional
default (anyOf 1)	boolean	Alternative
default (anyOf 2)	null	Alternative
defaultPriorityId	JSON	Optional
defaultPriorityId (anyOf 1)	string	Alternative	The ID of the default issue priority.
defaultPriorityId (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative	The description of the priority scheme
description (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the priority scheme.
id (anyOf 2)	null	Alternative
isDefault	JSON	Optional
isDefault (anyOf 1)	boolean	Alternative	write Only: true
isDefault (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the priority scheme
name (anyOf 2)	null	Alternative
priorities	JSON	Optional
priorities (anyOf 1)	Model	Alternative	Expand Get priorities by priority scheme — response body The paginated list of priorities.
priorities (anyOf 2)	null	Alternative
projects	JSON	Optional
projects (anyOf 1)	Model	Alternative	Expand Get issue type screen scheme projects — response body The paginated list of projects.
projects (anyOf 2)	null	Alternative
self	JSON	Optional
self (anyOf 1)	string	Alternative	The URL of the priority scheme.
self (anyOf 2)	null	Alternative

Referenced models: Get priorities by priority scheme — response body, Get issue type screen scheme projects — response body

Create priority scheme — request body — body mappings

Field	Type	Presence	Description and constraints
$	object	Root	Mapping of issue priorities for changes in priority schemes. write Only: true Additional keys: not allowed
in	object	Optional	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}`. write Only: true Additional keys: see wildcard field
in.*	integer	Additional keys	Format: int64 write Only: true
out	object	Optional	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}`. write Only: true Additional keys: see wildcard field
out.*	integer	Additional keys	Format: int64 write Only: true

Update priority scheme — request body — body priorities

Field	Type	Presence	Description and constraints
$	object	Root	Update priorities in a scheme write Only: true Additional keys: allowed
add	Model	Optional	Expand Update priority scheme — request body — body projects add Priorities to add to a scheme
remove	Model	Optional	Expand Update priority scheme — request body — body projects add Priorities to remove from a scheme

Referenced models: Update priority scheme — request body — body projects add

Update priority scheme — request body — body projects

Field	Type	Presence	Description and constraints
$	object	Root	Update projects in a scheme write Only: true Additional keys: allowed
add	Model	Optional	Expand Update priority scheme — request body — body projects add Projects to add to a scheme
remove	Model	Optional	Expand Update priority scheme — request body — body projects add Projects to remove from a scheme

Referenced models: Update priority scheme — request body — body projects add

Bulk set issues properties by list — request body — body properties value

Field	Type	Presence	Description and constraints
$	JSON	Root	Any JSON value.

Update priority scheme — request body — body projects add

Field	Type	Presence	Description and constraints
$	object	Root	write Only: true Additional keys: not allowed
ids	array	Required within parent	Affected entity ids. write Only: true
ids[]	integer	Each item	Format: int64 write Only: true

Policy, approvals and errors

SDK function policy ID: atlassian.updatepriorityscheme. Catalog operation: updatepriorityscheme. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["manage:jira-configuration"]

Official provider source