Atlassian: Priority schemes schemas
16 Atlassian schemas with complete fields and constraints.
← Priority schemes operations · All 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 — 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 |
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
Get priorities by priority scheme — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Get priorities by priority scheme — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Get priorities by priority scheme — response body — values The list of items item
Get priorities by priority scheme — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An issue priority with sequence information. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the issue priority. |
description (anyOf 2) | null | Alternative | |
iconUrl | JSON | Optional | |
iconUrl (anyOf 1) | string | Alternative | The URL of the icon for the issue priority. |
iconUrl (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the issue priority. |
id (anyOf 2) | null | Alternative | |
isDefault | JSON | Optional | |
isDefault (anyOf 1) | boolean | Alternative | Whether this priority is the default. |
isDefault (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the issue priority. |
name (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the issue priority. |
self (anyOf 2) | null | Alternative | |
sequence | JSON | Optional | |
sequence (anyOf 1) | string | Alternative | The sequence of the issue priority. |
sequence (anyOf 2) | null | Alternative | |
statusColor | JSON | Optional | |
statusColor (anyOf 1) | string | Alternative | The color used to indicate the issue priority. |
statusColor (anyOf 2) | null | Alternative |
Get priority schemes — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of items. |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. Read only: true |
isLast (anyOf 2) | null | Alternative | |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | The maximum number of items that could be returned. Format: int32 Read only: true |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
nextPage | JSON | Optional | |
nextPage (anyOf 1) | string | Alternative | If there is another page of results, the URL of the next page. Format: uri Read only: true |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the page. Format: uri Read only: true |
self (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | The index of the first item returned. Format: int64 Read only: true |
startAt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
startAt (anyOf 2) | null | Alternative | |
total | JSON | Optional | |
total (anyOf 1) | JSON | Alternative | |
total (anyOf 1) (anyOf 1) | integer | Alternative | The number of items returned. Format: int64 Read only: true |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of items. Read only: true |
values (anyOf 1)[] | Model | Each item | Expand Update priority scheme — response body — priority Scheme default, default Priority Id, description, id, is Default, name, priorities, projects, self |
values (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
Suggested priorities for mappings — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of changes to a priority scheme that require suggested priority mappings. Additional keys: not allowed |
maxResults | integer | Optional | The maximum number of results that could be on the page. Format: int32 write Only: true |
priorities | Model | Optional | Expand Suggested priorities for mappings — request body — body priorities The priority changes in the scheme. |
projects | Model | Optional | Expand Suggested priorities for mappings — request body — body projects The project changes in the scheme. |
schemeId | integer | Optional | The id of the priority scheme. Format: int64 write Only: true |
startAt | integer | Optional | The index of the first item returned on the page. Format: int64 write Only: true |
Referenced models: Suggested priorities for mappings — request body — body priorities, Suggested priorities for mappings — request body — body projects
Suggested priorities for mappings — request body — body priorities
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of changes to a priority scheme's priorities that require suggested priority mappings. write Only: true Additional keys: not allowed |
add | array | Optional | The ids of priorities being removed from the scheme. write Only: true |
add[] | integer | Each item | Format: int64 write Only: true |
remove | array | Optional | The ids of priorities being removed from the scheme. write Only: true |
remove[] | integer | Each item | Format: int64 write Only: true |
Suggested priorities for mappings — request body — body projects
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of changes to a priority scheme's projects that require suggested priority mappings. write Only: true Additional keys: not allowed |
add | array | Optional | The ids of projects being added to the scheme. write Only: true |
add[] | integer | Each item | Format: int64 write Only: true |
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 — 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
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 |
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 — 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
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