Atlassian: Workflows schemas (part 2)
8 Atlassian schemas with complete fields and constraints.
← Workflows operations · All schemas
Search workflows — response body — values List of workflows item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of a workflow. |
created | JSON | Optional | |
created (anyOf 1) | JSON | Alternative | |
created (anyOf 1) (anyOf 1) | string | Alternative | The creation date of the workflow. |
created (anyOf 1) (anyOf 2) | null | Alternative | |
created (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | The description of the workflow. |
description (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the workflow. |
id (anyOf 2) | null | Alternative | |
isEditable | JSON | Optional | |
isEditable (anyOf 1) | boolean | Alternative | Indicates if the workflow can be edited. |
isEditable (anyOf 2) | null | Alternative | |
loopedTransitionContainerLayout | JSON | Optional | |
loopedTransitionContainerLayout (anyOf 1) | Model | Alternative | Expand Read workflow version from history — response body — workflows array item start Point Layout value |
loopedTransitionContainerLayout (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the workflow. |
name (anyOf 2) | null | Alternative | |
scope | JSON | Optional | |
scope (anyOf 1) | Model | Alternative | Expand Bulk get workflow schemes — response body — item scope The scope of the workflow |
scope (anyOf 2) | null | Alternative | |
startPointLayout | JSON | Optional | |
startPointLayout (anyOf 1) | Model | Alternative | Expand Read workflow version from history — response body — workflows array item start Point Layout value |
startPointLayout (anyOf 2) | null | Alternative | |
statuses | JSON | Optional | |
statuses (anyOf 1) | array | Alternative | The statuses referenced in this workflow. Unique items: true |
statuses (anyOf 1)[] | Model | Each item | Expand Read workflow version from history — response body — workflows array item statuses array item |
statuses (anyOf 2) | null | Alternative | |
taskId | JSON | Optional | |
taskId (anyOf 1) | JSON | Alternative | |
taskId (anyOf 1) (anyOf 1) | string | Alternative | If there is a current [asynchronous task](#async-operations) operation for this workflow. |
taskId (anyOf 1) (anyOf 2) | null | Alternative | |
taskId (anyOf 2) | null | Alternative | |
transitions | JSON | Optional | |
transitions (anyOf 1) | array | Alternative | The transitions of the workflow. Unique items: true |
transitions (anyOf 1)[] | Model | Each item | Expand Read workflow version from history — response body — workflows array item transitions array item |
transitions (anyOf 2) | null | Alternative | |
updated | JSON | Optional | |
updated (anyOf 1) | JSON | Alternative | |
updated (anyOf 1) (anyOf 1) | string | Alternative | The last edited date of the workflow. |
updated (anyOf 1) (anyOf 2) | null | Alternative | |
updated (anyOf 2) | null | Alternative | |
version | JSON | Optional | |
version (anyOf 1) | Model | Alternative | Expand Bulk get workflow schemes — response body — item version id, version Number |
version (anyOf 2) | null | Alternative |
Referenced models: Bulk get workflow schemes — response body — item version id, version Number, Read workflow version from history — response body — workflows array item start Point Layout value, Bulk get workflow schemes — response body — item scope The scope of the workflow, Read workflow version from history — response body — workflows array item statuses array item, Read workflow version from history — response body — workflows array item transitions array item
Validate create workflows — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
payload | Model | Required within parent | Expand Bulk create workflows — request body — body |
validationOptions | Model | Optional | Expand Validate create workflows — request body — body validation Options |
Referenced models: Validate create workflows — request body — body validation Options, Bulk create workflows — request body — body
Validate create workflows — request body — body validation Options
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The level of validation to return from the API. If no values are provided, the default would return `WARNING` and `ERROR` level validation results. Additional keys: not allowed |
levels | array | Optional | Maximum items: 2 |
levels[] | string | Each item | One of: WARNING, ERROR |
Validate create workflows — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
errors | JSON | Optional | |
errors (anyOf 1) | array | Alternative | The list of validation errors. |
errors (anyOf 1)[] | Model | Each item | Expand Validate create workflows — response body — errors The list of validation errors item |
errors (anyOf 2) | null | Alternative |
Referenced models: Validate create workflows — response body — errors The list of validation errors item
Validate create workflows — response body — errors The list of validation errors item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The details about a workflow validation error. |
additionalDetails | JSON | Optional | |
additionalDetails (anyOf 1) | string | Alternative | Additional details about the validation error. |
additionalDetails (anyOf 2) | null | Alternative | |
code | JSON | Optional | |
code (anyOf 1) | string | Alternative | An error code. |
code (anyOf 2) | null | Alternative | |
elementReference | JSON | Optional | |
elementReference (anyOf 1) | Model | Alternative | Expand Validate create workflows — response body — errors The list of validation errors item element Reference property Key, rule Id, status Mapping Reference, status Reference, transition Id |
elementReference (anyOf 2) | null | Alternative | |
level | JSON | Optional | |
level (anyOf 1) | string | Alternative | The validation error level. Known values: WARNING, ERROR |
level (anyOf 2) | null | Alternative | |
message | JSON | Optional | |
message (anyOf 1) | string | Alternative | An error message. |
message (anyOf 2) | null | Alternative | |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | The type of element the error or warning references. Known values: RULE, STATUS, STATUS_LAYOUT, STATUS_PROPERTY, WORKFLOW, TRANSITION, TRANSITION_PROPERTY, SCOPE, STATUS_MAPPING, TRIGGER |
type (anyOf 2) | null | Alternative |
Validate create workflows — response body — errors The list of validation errors item element Reference property Key, rule Id, status Mapping Reference, status Reference, transition Id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A reference to the location of the error. This will be null if the error does not refer to a specific element. |
propertyKey | JSON | Optional | |
propertyKey (anyOf 1) | string | Alternative | A property key. |
propertyKey (anyOf 2) | null | Alternative | |
ruleId | JSON | Optional | |
ruleId (anyOf 1) | string | Alternative | A rule ID. |
ruleId (anyOf 2) | null | Alternative | |
statusMappingReference | JSON | Optional | |
statusMappingReference (anyOf 1) | Model | Alternative | Expand Validate create workflows — response body — errors The list of validation errors item element Reference property Key, rule Id, status Mapping Reference, status Reference, transition Id status Mapping Reference issue Type Id, project Id |
statusMappingReference (anyOf 2) | null | Alternative | |
statusReference | JSON | Optional | |
statusReference (anyOf 1) | string | Alternative | A status reference. |
statusReference (anyOf 2) | null | Alternative | |
transitionId | JSON | Optional | |
transitionId (anyOf 1) | string | Alternative | A transition ID. |
transitionId (anyOf 2) | null | Alternative |
Validate create workflows — response body — errors The list of validation errors item element Reference property Key, rule Id, status Mapping Reference, status Reference, transition Id status Mapping Reference issue Type Id, project Id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A project and issueType ID pair that identifies a status mapping. |
issueTypeId | JSON | Optional | |
issueTypeId (anyOf 1) | string | Alternative | The ID of the issue type. |
issueTypeId (anyOf 2) | null | Alternative | |
projectId | JSON | Optional | |
projectId (anyOf 1) | string | Alternative | The ID of the project. |
projectId (anyOf 2) | null | Alternative |
Validate update workflows — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
payload | Model | Required within parent | Expand Bulk update workflows — request body — body |
validationOptions | Model | Optional | Expand Validate create workflows — request body — body validation Options |
Referenced models: Validate create workflows — request body — body validation Options, Bulk update workflows — request body — body