Atlassian: Issue type schemes schemas
11 Atlassian schemas with complete fields and constraints.
← Issue type schemes operations · All schemas
Assign issue type scheme to project — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the association between an issue type scheme and project. Additional keys: not allowed |
issueTypeSchemeId | string | Required within parent | The ID of the issue type scheme. write Only: true |
projectId | string | Required within parent | The ID of the project. write Only: true |
Change order of issue types — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An ordered list of issue type IDs and information about where to move them. Additional keys: not allowed |
after | string | Optional | The ID of the issue type to place the moved issue types after. Required if `position` isn't provided. write Only: true |
issueTypeIds | array | Required within parent | A list of the issue type IDs to move. The order of the issue type IDs in the list is the order they are given after the move. write Only: true |
issueTypeIds[] | string | Each item | write Only: true |
position | string | Optional | The position the issue types should be moved to. Required if `after` isn't provided. One of: First, Last write Only: true |
Create issue type scheme — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of an issue type scheme and its associated issue types. Additional keys: not allowed |
defaultIssueTypeId | string | Optional | The ID of the default issue type of the issue type scheme. This ID must be included in `issueTypeIds`. write Only: true |
description | string | Optional | The description of the issue type scheme. The maximum length is 4000 characters. write Only: true |
issueTypeIds | array | Required within parent | The list of issue types IDs of the issue type scheme. At least one standard issue type ID is required. write Only: true |
issueTypeIds[] | string | Each item | write Only: true |
name | string | Required within parent | The name of the issue type scheme. The name must be unique. The maximum length is 255 characters. write Only: true |
Create issue type scheme — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The ID of an issue type scheme. |
issueTypeSchemeId | JSON | Optional | |
issueTypeSchemeId (anyOf 1) | string | Alternative | The ID of the issue type scheme. Read only: true |
issueTypeSchemeId (anyOf 2) | null | Alternative |
Get all issue type 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 Get all issue type schemes — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Get all issue type schemes — response body — values The list of items item
Get all issue type schemes — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of an issue type scheme. |
defaultIssueTypeId | JSON | Optional | |
defaultIssueTypeId (anyOf 1) | string | Alternative | The ID of the default issue type of the issue type scheme. |
defaultIssueTypeId (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the issue type scheme. |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the issue type scheme. |
id (anyOf 2) | null | Alternative | |
isDefault | JSON | Optional | |
isDefault (anyOf 1) | boolean | Alternative | Whether the issue type scheme is the default. |
isDefault (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the issue type scheme. |
name (anyOf 2) | null | Alternative |
Get issue type scheme items — 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 issue type scheme items — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Get issue type scheme items — response body — values The list of items item
Get issue type scheme items — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Issue type scheme item. |
issueTypeId | JSON | Optional | |
issueTypeId (anyOf 1) | string | Alternative | The ID of the issue type. |
issueTypeId (anyOf 2) | null | Alternative | |
issueTypeSchemeId | JSON | Optional | |
issueTypeSchemeId (anyOf 1) | string | Alternative | The ID of the issue type scheme. |
issueTypeSchemeId (anyOf 2) | null | Alternative |
Get issue type schemes for projects — 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 issue type schemes for projects — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Get issue type schemes for projects — response body — values The list of items item
Get issue type schemes for projects — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Issue type scheme with a list of the projects that use it. |
issueTypeScheme | JSON | Optional | |
issueTypeScheme (anyOf 1) | Model | Alternative | Expand Get all issue type schemes — response body — values The list of items item Details of an issue type scheme. |
issueTypeScheme (anyOf 2) | null | Alternative | |
projectIds | JSON | Optional | |
projectIds (anyOf 1) | array | Alternative | The IDs of the projects using the issue type scheme. |
projectIds (anyOf 1)[] | string | Each item | |
projectIds (anyOf 2) | null | Alternative |
Referenced models: Get all issue type schemes — response body — values The list of items item
Update issue type scheme — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the name, description, and default issue type for an issue type scheme. Additional keys: not allowed |
defaultIssueTypeId | string | Optional | The ID of the default issue type of the issue type scheme. write Only: true |
description | string | Optional | The description of the issue type scheme. The maximum length is 4000 characters. write Only: true |
name | string | Optional | The name of the issue type scheme. The name must be unique. The maximum length is 255 characters. write Only: true |