Atlassian: Issue resolutions schemas
8 Atlassian schemas with complete fields and constraints.
← Issue resolutions operations · All schemas
Create resolution — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of an issue resolution. Additional keys: allowed |
description | string | Optional | The description of the resolution. Maximum length: 255 write Only: true |
name | string | Required within parent | The name of the resolution. Must be unique (case-insensitive). Maximum length: 60 write Only: true |
Create resolution — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The ID of an issue resolution. Additional keys: allowed |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the issue resolution. Read only: true |
id (anyOf 2) | null | Alternative |
Get resolution — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of an issue resolution. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the issue resolution. |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the issue resolution. |
id (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the issue resolution. |
name (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the issue resolution. Format: uri |
self (anyOf 2) | null | Alternative |
Move resolutions — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Change the order of issue resolutions. Additional keys: not allowed |
after | string | Optional | The ID of the resolution. Required if `position` isn't provided. write Only: true |
ids | array | Required within parent | The list of resolution 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 resolutions to be moved to. Required if `after` isn't provided. write Only: true |
Search resolutions — 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 Search resolutions — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Search resolutions — response body — values The list of items item
Search resolutions — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
default | JSON | Optional | |
default (anyOf 1) | boolean | Alternative | |
default (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | |
description (anyOf 2) | null | Alternative | |
iconUrl | JSON | Optional | |
iconUrl (anyOf 1) | string | Alternative | |
iconUrl (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | |
id (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | |
name (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | |
self (anyOf 2) | null | Alternative |
Set default resolution — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The new default issue resolution. Additional keys: not allowed |
id | string | Required within parent | The ID of the new default issue resolution. Must be an existing ID or null. Setting this to null erases the default resolution setting. write Only: true |
Update resolution — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of an issue resolution. Additional keys: allowed |
description | string | Optional | The description of the resolution. Maximum length: 255 write Only: true |
name | string | Required within parent | The name of the resolution. Must be unique. Maximum length: 60 write Only: true |