Atlassian: Status schemas
19 Atlassian schemas with complete fields and constraints.
← Status operations · All schemas
Bulk create statuses — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the statuses being created and their scope. Additional keys: not allowed |
scope | Model | Required within parent | Expand Bulk create statuses — request body — body scope |
statuses | array | Required within parent | Details of the statuses being created. |
statuses[] | Model | Each item | Expand Bulk create statuses — request body — body statuses item |
Referenced models: Bulk create statuses — request body — body statuses item, Bulk create statuses — request body — body scope
Bulk create statuses — request body — body scope
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The scope of the status. Additional keys: not allowed |
project | Model | Optional | Expand Bulk create statuses — request body — body scope project |
type | string | Required within parent | The scope of the status. `GLOBAL` for company-managed projects and `PROJECT` for team-managed projects. One of: PROJECT, GLOBAL |
Referenced models: Bulk create statuses — request body — body scope project
Bulk create statuses — request body — body scope project
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Project ID details. Additional keys: not allowed |
$ (anyOf 1).id | string | Required within parent | The ID of the project. |
$ (anyOf 2) | null | Alternative |
Bulk create statuses — request body — body statuses item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the status being created. Additional keys: not allowed |
description | string | Optional | The description of the status. |
name | string | Required within parent | The name of the status. Maximum length: 255 |
statusCategory | string | Required within parent | The category of the status. One of: TODO, IN_PROGRESS, DONE |
Bulk get statuses — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a status. |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the status. |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the status. |
id (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the status. |
name (anyOf 2) | null | Alternative | |
scope | JSON | Optional | |
scope (anyOf 1) | Model | Alternative | Expand Bulk get statuses — response body — item scope The scope of the status |
scope (anyOf 2) | null | Alternative | |
statusCategory | JSON | Optional | |
statusCategory (anyOf 1) | string | Alternative | The category of the status. Known values: TODO, IN_PROGRESS, DONE |
statusCategory (anyOf 2) | null | Alternative |
Referenced models: Bulk get statuses — response body — item scope The scope of the status
Bulk get statuses — response body — item scope The scope of the status
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The scope of the status. |
project | JSON | Optional | |
project (anyOf 1) | Model | Alternative | Expand Bulk get statuses — response body — item scope The scope of the status project value |
project (anyOf 2) | null | Alternative | |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | The scope of the status. `GLOBAL` for company-managed projects and `PROJECT` for team-managed projects. Known values: PROJECT, GLOBAL |
type (anyOf 2) | null | Alternative |
Referenced models: Bulk get statuses — response body — item scope The scope of the status project value
Bulk get statuses — response body — item scope The scope of the status project value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Project ID details. |
$ (anyOf 1).id | JSON | Optional | |
$ (anyOf 1).id (anyOf 1) | string | Alternative | The ID of the project. |
$ (anyOf 1).id (anyOf 2) | null | Alternative | |
$ (anyOf 2) | null | Alternative |
Bulk update statuses — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The list of statuses that will be updated. Additional keys: not allowed |
statuses | array | Required within parent | The list of statuses that will be updated. |
statuses[] | Model | Each item | Expand Bulk update statuses — request body — body statuses item |
Referenced models: Bulk update statuses — request body — body statuses item
Bulk update statuses — request body — body statuses item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the status being updated. Additional keys: allowed |
description | string | Optional | The description of the status. |
id | string | Required within parent | The ID of the status. |
name | string | Required within parent | The name of the status. |
statusCategory | string | Required within parent | The category of the status. One of: TODO, IN_PROGRESS, DONE |
Get issue type usages by status and project — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The issue types using this status in a project. |
issueTypes | JSON | Optional | |
issueTypes (anyOf 1) | Model | Alternative | Expand Get issue type usages by status and project — response body — issue Types A page of issue types |
issueTypes (anyOf 2) | null | Alternative | |
projectId | JSON | Optional | |
projectId (anyOf 1) | string | Alternative | The project ID. |
projectId (anyOf 2) | null | Alternative | |
statusId | JSON | Optional | |
statusId (anyOf 1) | string | Alternative | The status ID. |
statusId (anyOf 2) | null | Alternative |
Referenced models: Get issue type usages by status and project — response body — issue Types A page of issue types
Get issue type usages by status and project — response body — issue Types A page of issue types
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of issue types. |
nextPageToken | JSON | Optional | |
nextPageToken (anyOf 1) | string | Alternative | Page token for the next page of issue type usages. |
nextPageToken (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of issue types. |
values (anyOf 1)[] | Model | Each item | Expand Get issue type usages by status and project — response body — issue Types A page of issue types values The list of issue types item |
values (anyOf 2) | null | Alternative |
Referenced models: Get issue type usages by status and project — response body — issue Types A page of issue types values The list of issue types item
Get issue type usages by status and project — response body — issue Types A page of issue types values The list of issue types item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The list of issue types. |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The issue type ID. |
id (anyOf 2) | null | Alternative |
Get project usages by status — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The projects using this status. |
projects | JSON | Optional | |
projects (anyOf 1) | Model | Alternative | Expand Get project usages by status — response body — projects A page of projects |
projects (anyOf 2) | null | Alternative | |
statusId | JSON | Optional | |
statusId (anyOf 1) | string | Alternative | The status ID. |
statusId (anyOf 2) | null | Alternative |
Referenced models: Get project usages by status — response body — projects A page of projects
Get project usages by status — response body — projects A page of projects
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of projects. |
nextPageToken | JSON | Optional | |
nextPageToken (anyOf 1) | string | Alternative | Page token for the next page of issue type usages. |
nextPageToken (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of projects. |
values (anyOf 1)[] | Model | Each item | Expand Get project usages by status — response body — projects A page of projects values The list of projects item |
values (anyOf 2) | null | Alternative |
Referenced models: Get project usages by status — response body — projects A page of projects values The list of projects item
Get project usages by status — response body — projects A page of projects values The list of projects item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The project. |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The project ID. |
id (anyOf 2) | null | Alternative |
Get workflow usages by status — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Workflows using the status. |
statusId | JSON | Optional | |
statusId (anyOf 1) | string | Alternative | The status ID. |
statusId (anyOf 2) | null | Alternative | |
workflows | JSON | Optional | |
workflows (anyOf 1) | Model | Alternative | Expand Get workflow usages by status — response body — workflows A page of workflows |
workflows (anyOf 2) | null | Alternative |
Referenced models: Get workflow usages by status — response body — workflows A page of workflows
Get workflow usages by status — response body — workflows A page of workflows
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A page of workflows. |
nextPageToken | JSON | Optional | |
nextPageToken (anyOf 1) | string | Alternative | Page token for the next page of issue type usages. |
nextPageToken (anyOf 2) | null | Alternative | |
values | JSON | Optional | |
values (anyOf 1) | array | Alternative | The list of statuses. |
values (anyOf 1)[] | Model | Each item | Expand Get workflow usages by status — response body — workflows A page of workflows values The list of statuses item |
values (anyOf 2) | null | Alternative |
Referenced models: Get workflow usages by status — response body — workflows A page of workflows values The list of statuses item
Get workflow usages by status — response body — workflows A page of workflows values The list of statuses item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The worflow. |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The workflow ID. |
id (anyOf 2) | null | Alternative |
Search statuses paginated — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
isLast | JSON | Optional | |
isLast (anyOf 1) | boolean | Alternative | Whether this is the last page. |
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 |
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 | The URL of the next page of results, if any. |
nextPage (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of this page. |
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 on the page. 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 | Number of items that satisfy the search. Format: int64 |
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. |
values (anyOf 1)[] | Model | Each item | Expand Bulk get statuses — response body — item |
values (anyOf 2) | null | Alternative |
Referenced models: Bulk get statuses — response body — item