Atlassian: Create priority scheme

Atlassian prioritySchemes.createPriorityScheme: arguments, response, policy and SDK examples.

← Priority schemes operations · Get started

Operation atlassian.createpriorityscheme

Provider route: POST /{cloudId}/rest/api/3/priorityscheme. 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"]["createPriorityScheme"]>[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.createPriorityScheme(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.create_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}$
`body`	Model	Required within parent	Expand Create priority scheme — request body — body

Referenced models: Create 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
`$`	JSON	Root
`$ (anyOf 1)`	Model	Alternative	Expand Create priority scheme — response body — The ID of a priority scheme
`$ (anyOf 2)`	Model	Alternative	Expand Create priority scheme — response body — The ID of a priority scheme

Referenced models: Create priority scheme — response body — The ID of a priority scheme

Schemas

Create priority scheme — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a new priority scheme Additional keys: not allowed
`defaultPriorityId`	integer	Required within parent	The ID of the default priority for the priority 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 new priority scheme, no mapping needs to be provided as the new priorities are not used by any issues. * When priorities are removed from the new priority scheme, no mapping needs to be provided as the removed priorities are not used by any issues. * 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, no mapping needs to be provided as the removed projects are not using the priorities of the new priority scheme. For more information on `in` and `out` mappings, see the child properties documentation for the `PriorityMapping` object below.
`name`	string	Required within parent	The name of the priority scheme. Must be unique. Maximum length: 255 write Only: true
`priorityIds`	array	Required within parent	The IDs of priorities in the scheme. Maximum length: 300 Minimum length: 1 write Only: true
`priorityIds[]`	integer	Each item	Format: int64 Maximum length: 300 Minimum length: 1 write Only: true
`projectIds`	array	Optional	The IDs of projects that will use the priority scheme. Unique items: true write Only: true
`projectIds[]`	integer	Each item	Format: int64 write Only: true

Referenced models: Create priority scheme — request body — body mappings

Create priority scheme — response body — The ID of a priority scheme

Field	Type	Presence	Description and constraints
`$`	object	Root	The ID of a priority scheme.
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the priority scheme. Read only: true
`id (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 — task Details about a task

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 — response body — task Details about a task

Field	Type	Presence	Description and constraints
`$`	object	Root	Details about a task.
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	The description of the task.
`description (anyOf 2)`	null	Alternative
`elapsedRuntime`	JSON	Optional
`elapsedRuntime (anyOf 1)`	JSON	Alternative
`elapsedRuntime (anyOf 1) (anyOf 1)`	integer	Alternative	The execution time of the task, in milliseconds. Format: int64
`elapsedRuntime (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`elapsedRuntime (anyOf 2)`	null	Alternative
`finished`	JSON	Optional
`finished (anyOf 1)`	JSON	Alternative
`finished (anyOf 1) (anyOf 1)`	integer	Alternative	A timestamp recording when the task was finished. Format: int64
`finished (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`finished (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the task.
`id (anyOf 2)`	null	Alternative
`lastUpdate`	JSON	Optional
`lastUpdate (anyOf 1)`	JSON	Alternative
`lastUpdate (anyOf 1) (anyOf 1)`	integer	Alternative	A timestamp recording when the task progress was last updated. Format: int64
`lastUpdate (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`lastUpdate (anyOf 2)`	null	Alternative
`message`	JSON	Optional
`message (anyOf 1)`	string	Alternative	Information about the progress of the task.
`message (anyOf 2)`	null	Alternative
`progress`	JSON	Optional
`progress (anyOf 1)`	JSON	Alternative
`progress (anyOf 1) (anyOf 1)`	integer	Alternative	The progress of the task, as a percentage complete. Format: int64
`progress (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`progress (anyOf 2)`	null	Alternative
`result`	JSON	Optional
`result (anyOf 1)`	Model	Alternative	Expand Bulk set issues properties by list — request body — body properties value The result of the task execution.
`result (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of the task. Format: uri
`self (anyOf 2)`	null	Alternative
`started`	JSON	Optional
`started (anyOf 1)`	JSON	Alternative
`started (anyOf 1) (anyOf 1)`	integer	Alternative	A timestamp recording when the task was started. Format: int64
`started (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`started (anyOf 2)`	null	Alternative
`status`	JSON	Optional
`status (anyOf 1)`	string	Alternative	The status of the task. Known values: ENQUEUED, RUNNING, COMPLETE, FAILED, CANCEL_REQUESTED, CANCELLED, DEAD
`status (anyOf 2)`	null	Alternative
`submitted`	JSON	Optional
`submitted (anyOf 1)`	JSON	Alternative
`submitted (anyOf 1) (anyOf 1)`	integer	Alternative	A timestamp recording when the task was submitted. Format: int64
`submitted (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`submitted (anyOf 2)`	null	Alternative
`submittedBy`	JSON	Optional
`submittedBy (anyOf 1)`	JSON	Alternative
`submittedBy (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the user who submitted the task. Format: int64
`submittedBy (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`submittedBy (anyOf 2)`	null	Alternative

Referenced models: Bulk set issues properties by list — request body — body properties value

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

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

Policy, approvals and errors

SDK function policy ID: atlassian.createpriorityscheme. Catalog operation: createpriorityscheme. 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

Report an issue with this page