Atlassian: Issue priorities schemas
8 Atlassian schemas with complete fields and constraints.
← Issue priorities operations · All schemas
Create priority — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of an issue priority. Additional keys: allowed |
avatarId | integer | Optional | The ID for the avatar for the priority. Either the iconUrl or avatarId must be defined, but not both. This parameter is nullable and will become mandatory once the iconUrl parameter is deprecated. Format: int64 write Only: true |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the priority. Maximum length: 255 write Only: true |
description (anyOf 2) | null | Alternative | |
iconUrl | JSON | Optional | |
iconUrl (anyOf 1) | string | Alternative | The URL of an icon for the priority. Accepted protocols are HTTP and HTTPS. Built in icons can also be used. Either the iconUrl or avatarId must be defined, but not both. One of: /images/icons/priorities/blocker.png, /images/icons/priorities/critical.png, /images/icons/priorities/high.png, /images/icons/priorities/highest.png, /images/icons/priorities/low.png, /images/icons/priorities/lowest.png, /images/icons/priorities/major.png, /images/icons/priorities/medium.png, /images/icons/priorities/minor.png, /images/icons/priorities/trivial.png, /images/icons/priorities/blocker_new.png, /images/icons/priorities/critical_new.png, /images/icons/priorities/high_new.png, /images/icons/priorities/highest_new.png, /images/icons/priorities/low_new.png, /images/icons/priorities/lowest_new.png, /images/icons/priorities/major_new.png, /images/icons/priorities/medium_new.png, /images/icons/priorities/minor_new.png, /images/icons/priorities/trivial_new.png Maximum length: 255 write Only: true |
iconUrl (anyOf 2) | null | Alternative | |
name | string | Required within parent | The name of the priority. Must be unique. Maximum length: 60 write Only: true |
statusColor | string | Required within parent | The status color of the priority in 3-digit or 6-digit hexadecimal format. write Only: true |
Create priority — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The ID of an issue priority. Additional keys: allowed |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the issue priority. Read only: true |
id (anyOf 2) | null | Alternative |
Get priority — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An issue priority. Additional keys: allowed |
avatarId | JSON | Optional | |
avatarId (anyOf 1) | JSON | Alternative | |
avatarId (anyOf 1) (anyOf 1) | integer | Alternative | The avatarId of the avatar for the issue priority. This parameter is nullable and when set, this avatar references the universal avatar APIs. Format: int64 |
avatarId (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
avatarId (anyOf 2) | null | Alternative | |
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 | |
schemes | JSON | Optional | |
schemes (anyOf 1) | Model | Alternative | Expand Get priority — response body — schemes max Results, start At, total Priority schemes associated with the issue priority. |
schemes (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the issue priority. |
self (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 |
Referenced models: Get priority — response body — schemes max Results, start At, total
Get priority — response body — schemes max Results, start At, total
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
maxResults | JSON | Optional | |
maxResults (anyOf 1) | JSON | Alternative | |
maxResults (anyOf 1) (anyOf 1) | integer | Alternative | Format: int32 |
maxResults (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
maxResults (anyOf 2) | null | Alternative | |
startAt | JSON | Optional | |
startAt (anyOf 1) | JSON | Alternative | |
startAt (anyOf 1) (anyOf 1) | integer | Alternative | Format: int64 |
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 | Format: int64 |
total (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
total (anyOf 2) | null | Alternative |
Move priorities — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Change the order of issue priorities. Additional keys: not allowed |
after | string | Optional | The ID of the priority. Required if `position` isn't provided. write Only: true |
ids | array | Required within parent | The list of issue IDs to be reordered. Cannot contain duplicates nor after ID. write Only: true |
ids[] | string | Each item | write Only: true |
position | string | Optional | The position for issue priorities to be moved to. Required if `after` isn't provided. write Only: true |
Search priorities — 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 priority — response body |
values (anyOf 2) | null | Alternative |
Referenced models: Get priority — response body
Set default priority — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The new default issue priority. Additional keys: not allowed |
id | string | Required within parent | The ID of the new default issue priority. Must be an existing ID or null. Setting this to null erases the default priority setting. write Only: true |
Update priority — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of an issue priority. Additional keys: allowed |
avatarId | integer | Optional | The ID for the avatar for the priority. This parameter is nullable and both iconUrl and avatarId cannot be defined. Format: int64 write Only: true |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the priority. Maximum length: 255 write Only: true |
description (anyOf 2) | null | Alternative | |
iconUrl | JSON | Optional | |
iconUrl (anyOf 1) | string | Alternative | The URL of an icon for the priority. Accepted protocols are HTTP and HTTPS. Built in icons can also be used. Both iconUrl and avatarId cannot be defined. One of: /images/icons/priorities/blocker.png, /images/icons/priorities/critical.png, /images/icons/priorities/high.png, /images/icons/priorities/highest.png, /images/icons/priorities/low.png, /images/icons/priorities/lowest.png, /images/icons/priorities/major.png, /images/icons/priorities/medium.png, /images/icons/priorities/minor.png, /images/icons/priorities/trivial.png, /images/icons/priorities/blocker_new.png, /images/icons/priorities/critical_new.png, /images/icons/priorities/high_new.png, /images/icons/priorities/highest_new.png, /images/icons/priorities/low_new.png, /images/icons/priorities/lowest_new.png, /images/icons/priorities/major_new.png, /images/icons/priorities/medium_new.png, /images/icons/priorities/minor_new.png, /images/icons/priorities/trivial_new.png Maximum length: 255 write Only: true |
iconUrl (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the priority. Must be unique. Maximum length: 60 write Only: true |
name (anyOf 2) | null | Alternative | |
statusColor | JSON | Optional | |
statusColor (anyOf 1) | string | Alternative | The status color of the priority in 3-digit or 6-digit hexadecimal format. write Only: true |
statusColor (anyOf 2) | null | Alternative |