Atlassian: Issue types schemas
3 Atlassian schemas with complete fields and constraints.
← Issue types operations · All schemas
Create issue type — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
description | string | Optional | The description of the issue type. |
hierarchyLevel | integer | Optional | The hierarchy level of the issue type. Use: * `-1` for Subtask. * `0` for Base. Defaults to `0`. Format: int32 |
name | string | Required within parent | The unique name for the issue type. The maximum length is 60 characters. |
type | string | Optional | Deprecated. Use `hierarchyLevel` instead. See the [deprecation notice](https://community.developer.atlassian.com/t/deprecation-of-the-epic-link-parent-link-and-other-related-fields-in-rest-apis-and-webhooks/54048) for details. Whether the issue type is `subtype` or `standard`. Defaults to `standard`. One of: subtask, standard |
Get issue type — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about an issue type. |
avatarId | JSON | Optional | |
avatarId (anyOf 1) | JSON | Alternative | |
avatarId (anyOf 1) (anyOf 1) | integer | Alternative | The ID of the issue type's avatar. Format: int64 Read only: true |
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 type. Read only: true |
description (anyOf 2) | null | Alternative | |
entityId | JSON | Optional | |
entityId (anyOf 1) | string | Alternative | Unique ID for next-gen projects. Format: uuid Read only: true |
entityId (anyOf 2) | null | Alternative | |
hierarchyLevel | JSON | Optional | |
hierarchyLevel (anyOf 1) | JSON | Alternative | |
hierarchyLevel (anyOf 1) (anyOf 1) | integer | Alternative | Hierarchy level of the issue type. Format: int32 Read only: true |
hierarchyLevel (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hierarchyLevel (anyOf 2) | null | Alternative | |
iconUrl | JSON | Optional | |
iconUrl (anyOf 1) | string | Alternative | The URL of the issue type's avatar. Read only: true |
iconUrl (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the issue type. Read only: true |
id (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the issue type. Read only: true |
name (anyOf 2) | null | Alternative | |
scope | JSON | Optional | |
scope (anyOf 1) | Model | Alternative | Expand Get status — response body — scope project, type Details of the next-gen projects the issue type is available in. Read only: true |
scope (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of these issue type details. Read only: true |
self (anyOf 2) | null | Alternative | |
subtask | JSON | Optional | |
subtask (anyOf 1) | boolean | Alternative | Whether this issue type is used to create subtasks. Read only: true |
subtask (anyOf 2) | null | Alternative |
Referenced models: Get status — response body — scope project, type
Update issue type — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
avatarId | integer | Optional | The ID of an issue type avatar. This can be obtained be obtained from the following endpoints: * [System issue type avatar IDs only](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-avatars/#api-rest-api-3-avatar-type-system-get) * [System and custom issue type avatar IDs](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-avatars/#api-rest-api-3-universal-avatar-type-type-owner-entityid-get) Format: int64 |
description | string | Optional | The description of the issue type. |
name | string | Optional | The unique name for the issue type. The maximum length is 60 characters. |