Atlassian: Workflow transition rules schemas
14 Atlassian schemas with complete fields and constraints.
← Workflow transition rules operations · All schemas
Get workflow transition rule configurations — 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 workflow transition rule configurations — response body — values The list of items item |
values (anyOf 2) | null | Alternative |
Referenced models: Get workflow transition rule configurations — response body — values The list of items item
Get workflow transition rule configurations — response body — values The list of items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A workflow with transition rules. |
conditions | JSON | Optional | |
conditions (anyOf 1) | array | Alternative | The list of conditions within the workflow. |
conditions (anyOf 1)[] | Model | Each item | Expand Get workflow transition rule configurations — response body — values The list of items item conditions The list of conditions within the workflow item |
conditions (anyOf 2) | null | Alternative | |
postFunctions | JSON | Optional | |
postFunctions (anyOf 1) | array | Alternative | The list of post functions within the workflow. |
postFunctions (anyOf 1)[] | Model | Each item | Expand Get workflow transition rule configurations — response body — values The list of items item conditions The list of conditions within the workflow item |
postFunctions (anyOf 2) | null | Alternative | |
validators | JSON | Optional | |
validators (anyOf 1) | array | Alternative | The list of validators within the workflow. |
validators (anyOf 1)[] | Model | Each item | Expand Get workflow transition rule configurations — response body — values The list of items item conditions The list of conditions within the workflow item |
validators (anyOf 2) | null | Alternative | |
workflowId | JSON | Optional | |
workflowId (anyOf 1) | Model | Alternative | Expand Get workflow transition rule configurations — response body — values The list of items item workflow Id Properties that identify a workflow |
workflowId (anyOf 2) | null | Alternative |
Referenced models: Get workflow transition rule configurations — response body — values The list of items item conditions The list of conditions within the workflow item, Get workflow transition rule configurations — response body — values The list of items item workflow Id Properties that identify a workflow
Get workflow transition rule configurations — response body — values The list of items item conditions The list of conditions within the workflow item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A workflow transition rule. |
configuration | JSON | Optional | |
configuration (anyOf 1) | Model | Alternative | Expand Get workflow transition rule configurations — response body — values The list of items item conditions The list of conditions within the workflow item configuration A rule configuration |
configuration (anyOf 2) | null | Alternative | |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the transition rule. |
id (anyOf 2) | null | Alternative | |
key | JSON | Optional | |
key (anyOf 1) | string | Alternative | The key of the rule, as defined in the Connect or the Forge app descriptor. Read only: true |
key (anyOf 2) | null | Alternative | |
transition | JSON | Optional | |
transition (anyOf 1) | Model | Alternative | Expand Get workflow transition rule configurations — response body — values The list of items item conditions The list of conditions within the workflow item transition A workflow transition Read only: true |
transition (anyOf 2) | null | Alternative |
Referenced models: Get workflow transition rule configurations — response body — values The list of items item conditions The list of conditions within the workflow item configuration A rule configuration, Get workflow transition rule configurations — response body — values The list of items item conditions The list of conditions within the workflow item transition A workflow transition
Get workflow transition rule configurations — response body — values The list of items item conditions The list of conditions within the workflow item configuration A rule configuration
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A rule configuration. |
disabled | JSON | Optional | |
disabled (anyOf 1) | boolean | Alternative | Whether the rule is disabled. Default: false |
disabled (anyOf 2) | null | Alternative | |
tag | JSON | Optional | |
tag (anyOf 1) | string | Alternative | A tag used to filter rules in [Get workflow transition rule configurations](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-rules/#api-rest-api-3-workflow-rule-config-get). Maximum length: 255 |
tag (anyOf 2) | null | Alternative | |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | Configuration of the rule, as it is stored by the Connect or the Forge app on the rule configuration page. |
value (anyOf 2) | null | Alternative |
Get workflow transition rule configurations — response body — values The list of items item conditions The list of conditions within the workflow item transition A workflow transition
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A workflow transition. |
id | JSON | Optional | |
id (anyOf 1) | JSON | Alternative | |
id (anyOf 1) (anyOf 1) | integer | Alternative | The transition ID. Format: int32 |
id (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
id (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The transition name. |
name (anyOf 2) | null | Alternative |
Get workflow transition rule configurations — response body — values The list of items item workflow Id Properties that identify a workflow
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Properties that identify a workflow. |
draft | JSON | Optional | |
draft (anyOf 1) | boolean | Alternative | **Deprecated:** Whether the workflow is in the draft state. The 'draft' parameter will be removed from this API on [November 2, 2026](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-3147). |
draft (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the workflow. |
name (anyOf 2) | null | Alternative |
Update workflow transition rule configurations — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about a workflow configuration update request. Additional keys: not allowed |
workflows | array | Required within parent | The list of workflows with transition rules to update. |
workflows[] | Model | Each item | Expand Update workflow transition rule configurations — request body — body workflows item |
Referenced models: Update workflow transition rule configurations — request body — body workflows item
Update workflow transition rule configurations — request body — body workflows item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A workflow with transition rules. Additional keys: not allowed |
conditions | array | Optional | The list of conditions within the workflow. |
conditions[] | Model | Each item | Expand Update workflow transition rule configurations — request body — body workflows item conditions item |
postFunctions | array | Optional | The list of post functions within the workflow. |
postFunctions[] | Model | Each item | Expand Update workflow transition rule configurations — request body — body workflows item conditions item |
validators | array | Optional | The list of validators within the workflow. |
validators[] | Model | Each item | Expand Update workflow transition rule configurations — request body — body workflows item conditions item |
workflowId | Model | Required within parent | Expand Update workflow transition rule configurations — request body — body workflows item workflow Id |
Referenced models: Update workflow transition rule configurations — request body — body workflows item conditions item, Update workflow transition rule configurations — request body — body workflows item workflow Id
Update workflow transition rule configurations — request body — body workflows item conditions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A workflow transition rule. Additional keys: not allowed |
configuration | Model | Required within parent | Expand Update workflow transition rule configurations — request body — body workflows item conditions item configuration |
id | string | Required within parent | The ID of the transition rule. |
key | string | Required within parent | The key of the rule, as defined in the Connect or the Forge app descriptor. Read only: true |
transition | Model | Optional | Expand Update workflow transition rule configurations — request body — body workflows item conditions item transition Read only: true |
Referenced models: Update workflow transition rule configurations — request body — body workflows item conditions item configuration, Update workflow transition rule configurations — request body — body workflows item conditions item transition
Update workflow transition rule configurations — request body — body workflows item conditions item configuration
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A rule configuration. Additional keys: not allowed |
disabled | boolean | Optional | Whether the rule is disabled. Default: false |
tag | string | Optional | A tag used to filter rules in [Get workflow transition rule configurations](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-rules/#api-rest-api-3-workflow-rule-config-get). Maximum length: 255 |
value | string | Required within parent | Configuration of the rule, as it is stored by the Connect or the Forge app on the rule configuration page. |
Update workflow transition rule configurations — request body — body workflows item conditions item transition
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A workflow transition. Additional keys: not allowed |
id | integer | Required within parent | The transition ID. Format: int32 |
name | string | Required within parent | The transition name. |
Update workflow transition rule configurations — request body — body workflows item workflow Id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Properties that identify a workflow. Additional keys: not allowed |
draft | boolean | Optional | **Deprecated:** Whether the workflow is in the draft state. The 'draft' parameter will be removed from this API on [November 2, 2026](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-3147). |
name | string | Required within parent | The name of the workflow. |
Update workflow transition rule configurations — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of any errors encountered while updating workflow transition rules. |
updateResults | JSON | Optional | |
updateResults (anyOf 1) | array | Alternative | A list of workflows. |
updateResults (anyOf 1)[] | Model | Each item | Expand Update workflow transition rule configurations — response body — update Results A list of workflows item |
updateResults (anyOf 2) | null | Alternative |
Referenced models: Update workflow transition rule configurations — response body — update Results A list of workflows item
Update workflow transition rule configurations — response body — update Results A list of workflows item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of any errors encountered while updating workflow transition rules for a workflow. |
ruleUpdateErrors | JSON | Optional | |
ruleUpdateErrors (anyOf 1) | object | Alternative | A list of transition rule update errors, indexed by the transition rule ID. Any transition rule that appears here wasn't updated. Additional keys: see wildcard field |
ruleUpdateErrors (anyOf 1).* | array | Additional keys | A list of transition rule update errors, indexed by the transition rule ID. Any transition rule that appears here wasn't updated. Unique items: true |
ruleUpdateErrors (anyOf 1).*[] | string | Each item | A list of transition rule update errors, indexed by the transition rule ID. Any transition rule that appears here wasn't updated. |
ruleUpdateErrors (anyOf 2) | null | Alternative | |
updateErrors | JSON | Optional | |
updateErrors (anyOf 1) | array | Alternative | The list of errors that specify why the workflow update failed. The workflow was not updated if the list contains any entries. Unique items: true |
updateErrors (anyOf 1)[] | string | Each item | An error specifying why the workflow update failed. |
updateErrors (anyOf 2) | null | Alternative | |
workflowId | JSON | Optional | |
workflowId (anyOf 1) | Model | Alternative | Expand Get workflow transition rule configurations — response body — values The list of items item workflow Id Properties that identify a workflow |
workflowId (anyOf 2) | null | Alternative |
Referenced models: Get workflow transition rule configurations — response body — values The list of items item workflow Id Properties that identify a workflow