Atlassian: Workflows schemas (part 1)

← Workflows operations · All schemas

Bulk create workflows — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	The create workflows payload. Additional keys: not allowed
scope	Model	Optional	Expand Bulk create workflows — request body — body scope
statuses	array	Optional	The statuses to associate with the workflows. Maximum: 1000
statuses[]	Model	Each item	Expand Bulk create workflows — request body — body statuses item
workflows	array	Optional	The details of the workflows to create. Maximum: 20
workflows[]	Model	Each item	Expand Bulk create workflows — request body — body workflows item

Referenced models: Bulk create workflows — request body — body workflows item, Bulk create workflows — request body — body scope, Bulk create workflows — request body — body statuses item

Bulk create workflows — request body — body scope

Field	Type	Presence	Description and constraints
$	object	Root	The scope of the workflow. Additional keys: not allowed
project	Model	Optional	Expand Bulk create statuses — request body — body scope project
type	string	Optional	The scope of the workflow. `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 workflows — request body — body statuses item

Field	Type	Presence	Description and constraints
$	object	Root	Details of the status being updated. Maximum: 1000 Additional keys: allowed
description	string	Optional	The description of the status.
id	string	Optional	The ID of the status. When reusing an existing status, this field should be provided.
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
statusReference	string	Required within parent	The reference of the status. If adding a new status to a team-managed workflow, this must be a UUID (for company-managed a UUID is not needed).

Bulk create workflows — request body — body workflows item

Field	Type	Presence	Description and constraints
$	object	Root	The details of the workflows to create. Maximum: 20 Additional keys: not allowed
description	string	Optional	The description of the workflow to create.
loopedTransitionContainerLayout	Model	Optional	Expand Bulk create workflows — request body — body workflows item start Point Layout
name	string	Required within parent	The name of the workflow to create.
startPointLayout	Model	Optional	Expand Bulk create workflows — request body — body workflows item start Point Layout
statuses	array	Required within parent	The statuses associated with this workflow.
statuses[]	Model	Each item	Expand Bulk create workflows — request body — body workflows item statuses item
transitions	array	Required within parent	The transitions of this workflow.
transitions[]	Model	Each item	Expand Bulk create workflows — request body — body workflows item transitions item

Referenced models: Bulk create workflows — request body — body workflows item statuses item, Bulk create workflows — request body — body workflows item transitions item, Bulk create workflows — request body — body workflows item start Point Layout

Bulk create workflows — request body — body workflows item start Point Layout

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	The starting point for the statuses in the workflow. Additional keys: not allowed
$ (anyOf 1).x	number	Optional	The x axis location. Format: double
$ (anyOf 1).y	number	Optional	The y axis location. Format: double
$ (anyOf 2)	null	Alternative

Bulk create workflows — request body — body workflows item statuses item

Field	Type	Presence	Description and constraints
$	object	Root	The statuses associated with this workflow. Additional keys: allowed
approvalConfiguration	Model	Optional	Expand Bulk create workflows — request body — body workflows item statuses item approval Configuration
layout	Model	Optional	Expand Bulk create workflows — request body — body workflows item start Point Layout
properties	object	Required within parent	The properties for this status layout. Additional keys: see wildcard field
properties.*	string	Additional keys	The properties for this status layout.
statusReference	string	Required within parent	A unique ID which the status will use to refer to this layout configuration.

Referenced models: Bulk create workflows — request body — body workflows item statuses item approval Configuration, Bulk create workflows — request body — body workflows item start Point Layout

Bulk create workflows — request body — body workflows item statuses item approval Configuration

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	The approval configuration of a status within a workflow. Applies only to Jira Service Management approvals. Additional keys: not allowed
$ (anyOf 1).active	string	Required within parent	Whether the approval configuration is active. One of: true, false
$ (anyOf 1).conditionType	string	Required within parent	How the required approval count is calculated. It may be configured to require a specific number of approvals, or approval by a percentage of approvers. If the approvers source field is Approver groups, you can configure how many approvals per group are required for the request to be approved. The number will be the same across all groups. One of: number, percent, numberPerPrincipal
$ (anyOf 1).conditionValue	string	Required within parent	The number or percentage of approvals required for a request to be approved. If `conditionType` is `number`, the value must be 20 or less. If `conditionType` is `percent`, the value must be 100 or less.
$ (anyOf 1).exclude	JSON	Optional
$ (anyOf 1).exclude (anyOf 1)	array	Alternative	A list of roles that should be excluded as possible approvers.
$ (anyOf 1).exclude (anyOf 1)[]	JSON	Each item
$ (anyOf 1).exclude (anyOf 1)[] (anyOf 1)	string	Alternative	A list of roles that should be excluded as possible approvers. One of: assignee, reporter
$ (anyOf 1).exclude (anyOf 1)[] (anyOf 2)	null	Alternative
$ (anyOf 1).exclude (anyOf 2)	null	Alternative
$ (anyOf 1).fieldId	string	Required within parent	The custom field ID of the "Approvers" or "Approver Groups" field.
$ (anyOf 1).prePopulatedFieldId	JSON	Optional
$ (anyOf 1).prePopulatedFieldId (anyOf 1)	string	Alternative	The custom field ID of the field used to pre-populate the Approver field. Only supports the "Affected Services" field.
$ (anyOf 1).prePopulatedFieldId (anyOf 2)	null	Alternative
$ (anyOf 1).transitionApproved	string	Required within parent	The numeric ID of the transition to be executed if the request is approved.
$ (anyOf 1).transitionRejected	string	Required within parent	The numeric ID of the transition to be executed if the request is declined.
$ (anyOf 2)	null	Alternative

Bulk create workflows — request body — body workflows item transitions item

Field	Type	Presence	Description and constraints
$	object	Root	The transition update data. Additional keys: allowed
actions	array	Optional	The post-functions of the transition.
actions[]	Model	Each item	Expand Bulk create workflows — request body — body workflows item transitions item transition Screen
conditions	Model	Optional	Expand Bulk create workflows — request body — body workflows item transitions item conditions
customIssueEventId	string	Optional	The custom event ID of the transition.
description	string	Optional	The description of the transition.
id	string	Optional	The ID of the transition.
links	array	Optional	The statuses the transition can start from, and the mapping of ports between the statuses.
links[]	Model	Each item	Expand Bulk create workflows — request body — body workflows item transitions item links item
name	string	Optional	The name of the transition.
properties	object	Optional	The properties of the transition. Additional keys: see wildcard field
properties.*	string	Additional keys	The properties of the transition.
toStatusReference	string	Optional	The status the transition goes to.
transitionScreen	Model	Optional	Expand Bulk create workflows — request body — body workflows item transitions item transition Screen
triggers	array	Optional	The triggers of the transition.
triggers[]	Model	Each item	Expand Bulk create workflows — request body — body workflows item transitions item triggers item
type	string	Optional	The transition type. One of: INITIAL, GLOBAL, DIRECTED
validators	array	Optional	The validators of the transition.
validators[]	Model	Each item	Expand Bulk create workflows — request body — body workflows item transitions item transition Screen

Referenced models: Bulk create workflows — request body — body workflows item transitions item conditions, Bulk create workflows — request body — body workflows item transitions item transition Screen, Bulk create workflows — request body — body workflows item transitions item links item, Bulk create workflows — request body — body workflows item transitions item triggers item

Bulk create workflows — request body — body workflows item transitions item conditions

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	The conditions group associated with the transition. Additional keys: not allowed
$ (anyOf 1).conditionGroups	array	Optional	The nested conditions of the condition group.
$ (anyOf 1).conditionGroups[]	Model	Each item	Expand Bulk create workflows — request body — body workflows item transitions item conditions
$ (anyOf 1).conditions	array	Optional	The rules for this condition.
$ (anyOf 1).conditions[]	Model	Each item	Expand Bulk create workflows — request body — body workflows item transitions item transition Screen
$ (anyOf 1).operation	string	Required within parent	Determines how the conditions in the group are evaluated. Accepts either `ANY` or `ALL`. If `ANY` is used, at least one condition in the group must be true for the group to evaluate to true. If `ALL` is used, all conditions in the group must be true for the group to evaluate to true. One of: ANY, ALL
$ (anyOf 2)	null	Alternative

Referenced models: Bulk create workflows — request body — body workflows item transitions item conditions, Bulk create workflows — request body — body workflows item transitions item transition Screen

Bulk create workflows — request body — body workflows item transitions item links item

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	The statuses the transition can start from, and the mapping of ports between the statuses. Additional keys: not allowed
$ (anyOf 1).fromPort	JSON	Optional
$ (anyOf 1).fromPort (anyOf 1)	integer	Alternative	The port that the transition starts from. Format: int32
$ (anyOf 1).fromPort (anyOf 2)	null	Alternative
$ (anyOf 1).fromStatusReference	JSON	Optional
$ (anyOf 1).fromStatusReference (anyOf 1)	string	Alternative	The status that the transition starts from.
$ (anyOf 1).fromStatusReference (anyOf 2)	null	Alternative
$ (anyOf 1).toPort	JSON	Optional
$ (anyOf 1).toPort (anyOf 1)	integer	Alternative	The port that the transition goes to. Format: int32
$ (anyOf 1).toPort (anyOf 2)	null	Alternative
$ (anyOf 2)	null	Alternative

Bulk create workflows — request body — body workflows item transitions item transition Screen

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	The configuration of the rule. Additional keys: not allowed
$ (anyOf 1).id	JSON	Optional
$ (anyOf 1).id (anyOf 1)	string	Alternative	The ID of the rule.
$ (anyOf 1).id (anyOf 2)	null	Alternative
$ (anyOf 1).parameters	object	Optional	The parameters related to the rule. Additional keys: see wildcard field
$ (anyOf 1).parameters.*	string	Additional keys	The parameters related to the rule.
$ (anyOf 1).ruleKey	string	Required within parent	The rule key of the rule.
$ (anyOf 2)	null	Alternative

Bulk create workflows — request body — body workflows item transitions item triggers item

Field	Type	Presence	Description and constraints
$	object	Root	The trigger configuration associated with a workflow. Additional keys: not allowed
id	string	Optional	The ID of the trigger.
parameters	object	Required within parent	The parameters of the trigger. Additional keys: see wildcard field
parameters.*	string	Additional keys	The parameters of the trigger.
ruleKey	string	Required within parent	The rule key of the trigger.

Bulk get workflows — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
projectAndIssueTypes	array	Optional	The list of projects and issue types to query.
projectAndIssueTypes[]	Model	Each item	Expand Bulk get workflows — request body — body project And Issue Types item
workflowIds	array	Optional	The list of workflow IDs to query.
workflowIds[]	string	Each item	The list of workflow IDs to query.
workflowNames	array	Optional	The list of workflow names to query.
workflowNames[]	string	Each item	The list of workflow names to query.

Referenced models: Bulk get workflows — request body — body project And Issue Types item

Bulk get workflows — request body — body project And Issue Types item

Field	Type	Presence	Description and constraints
$	object	Root	A project and issueType ID pair that identifies a status mapping. Additional keys: not allowed
issueTypeId	string	Required within parent	The ID of the issue type.
projectId	string	Required within parent	The ID of the project.

Bulk get workflows — response body

Field	Type	Presence	Description and constraints
$	object	Root	Details of workflows and related statuses.
statuses	JSON	Optional
statuses (anyOf 1)	array	Alternative	List of statuses. Unique items: true
statuses (anyOf 1)[]	Model	Each item	Expand Search workflows — response body — statuses List of statuses item
statuses (anyOf 2)	null	Alternative
workflows	JSON	Optional
workflows (anyOf 1)	array	Alternative	List of workflows. Unique items: true
workflows (anyOf 1)[]	Model	Each item	Expand Search workflows — response body — values List of workflows item
workflows (anyOf 2)	null	Alternative

Referenced models: Search workflows — response body — values List of workflows item, Search workflows — response body — statuses List of statuses item

Bulk update workflows — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	The update workflows payload. Additional keys: not allowed
statuses	array	Optional	The statuses to associate with the workflows. Maximum: 1000
statuses[]	Model	Each item	Expand Bulk create workflows — request body — body statuses item
workflows	array	Optional	The details of the workflows to update. Maximum: 20
workflows[]	Model	Each item	Expand Bulk update workflows — request body — body workflows item

Referenced models: Bulk create workflows — request body — body statuses item, Bulk update workflows — request body — body workflows item

Bulk update workflows — request body — body workflows item

Field	Type	Presence	Description and constraints
$	object	Root	The details of the workflows to update. Maximum: 20 Additional keys: allowed
defaultStatusMappings	array	Optional	The mapping of old to new status ID.
defaultStatusMappings[]	Model	Each item	Expand Bulk update workflows — request body — body workflows item default Status Mappings item
description	string	Optional	The new description for this workflow.
id	string	Required within parent	The ID of this workflow.
loopedTransitionContainerLayout	Model	Optional	Expand Bulk create workflows — request body — body workflows item start Point Layout
startPointLayout	Model	Optional	Expand Bulk create workflows — request body — body workflows item start Point Layout
statusMappings	array	Optional	The mapping of old to new status ID for a specific project and issue type.
statusMappings[]	Model	Each item	Expand Bulk update workflows — request body — body workflows item status Mappings item
statuses	array	Required within parent	The statuses associated with this workflow.
statuses[]	Model	Each item	Expand Bulk create workflows — request body — body workflows item statuses item
transitions	array	Required within parent	The transitions of this workflow.
transitions[]	Model	Each item	Expand Bulk create workflows — request body — body workflows item transitions item
version	Model	Required within parent	Expand Update workflow scheme — request body — body version

Referenced models: Update workflow scheme — request body — body version, Bulk create workflows — request body — body workflows item statuses item, Bulk update workflows — request body — body workflows item status Mappings item, Bulk update workflows — request body — body workflows item default Status Mappings item, Bulk create workflows — request body — body workflows item transitions item, Bulk create workflows — request body — body workflows item start Point Layout

Bulk update workflows — request body — body workflows item default Status Mappings item

Field	Type	Presence	Description and constraints
$	object	Root	The mapping of old to new status ID. Additional keys: allowed
newStatusReference	string	Required within parent	The new status ID.
oldStatusReference	string	Required within parent	The old status ID.

Bulk update workflows — request body — body workflows item status Mappings item

Field	Type	Presence	Description and constraints
$	object	Root	The mapping of old to new status ID for a specific project and issue type. Additional keys: allowed
issueTypeId	string	Required within parent	The issue type for the status mapping.
projectId	string	Required within parent	The project for the status mapping.
statusMigrations	array	Required within parent	The list of old and new status ID mappings for the specified project and issue type.
statusMigrations[]	Model	Each item	Expand Bulk update workflows — request body — body workflows item default Status Mappings item

Referenced models: Bulk update workflows — request body — body workflows item default Status Mappings item

Bulk update workflows — response body

Field	Type	Presence	Description and constraints
$	object	Root
statuses	JSON	Optional
statuses (anyOf 1)	array	Alternative	List of updated statuses. Unique items: true
statuses (anyOf 1)[]	Model	Each item	Expand Search workflows — response body — statuses List of statuses 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 [asynchronous task](#async-operations) operation, as a result of this update.
taskId (anyOf 1) (anyOf 2)	null	Alternative
taskId (anyOf 2)	null	Alternative
workflows	JSON	Optional
workflows (anyOf 1)	array	Alternative	List of updated workflows. Unique items: true
workflows (anyOf 1)[]	Model	Each item	Expand Search workflows — response body — values List of workflows item
workflows (anyOf 2)	null	Alternative

Referenced models: Search workflows — response body — values List of workflows item, Search workflows — response body — statuses List of statuses item

Copy workflow — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	The copy workflow payload. Additional keys: not allowed
description	string	Optional	The description of the new workflow to create. Defaults to an empty description. Maximum length: 2048 Minimum length: 0
workflowId	string	Required within parent	The ID of the workflow to copy. Maximum length: 255 Minimum length: 1
workflowName	string	Required within parent	The name of the new workflow to create. Maximum length: 255 Minimum length: 1

Copy workflow — response body

Field	Type	Presence	Description and constraints
$	object	Root	Details of the created workflows and statuses.
statuses	JSON	Optional
statuses (anyOf 1)	array	Alternative	List of created statuses. Unique items: true
statuses (anyOf 1)[]	Model	Each item	Expand Search workflows — response body — statuses List of statuses item
statuses (anyOf 2)	null	Alternative
workflows	JSON	Optional
workflows (anyOf 1)	array	Alternative	List of created workflows. Unique items: true
workflows (anyOf 1)[]	Model	Each item	Expand Search workflows — response body — values List of workflows item
workflows (anyOf 2)	null	Alternative

Referenced models: Search workflows — response body — values List of workflows item, Search workflows — response body — statuses List of statuses item

Get available workflow capabilities — response body

Field	Type	Presence	Description and constraints
$	object	Root
connectRules	JSON	Optional
connectRules (anyOf 1)	array	Alternative	The Connect provided ecosystem rules available.
connectRules (anyOf 1)[]	Model	Each item	Expand Get available workflow capabilities — response body — connect Rules The Connect provided ecosystem rules available item
connectRules (anyOf 2)	null	Alternative
editorScope	JSON	Optional
editorScope (anyOf 1)	string	Alternative	The scope of the workflow capabilities. `GLOBAL` for company-managed projects and `PROJECT` for team-managed projects. Known values: PROJECT, GLOBAL
editorScope (anyOf 2)	null	Alternative
forgeRules	JSON	Optional
forgeRules (anyOf 1)	array	Alternative	The Forge provided ecosystem rules available.
forgeRules (anyOf 1)[]	Model	Each item	Expand Get available workflow capabilities — response body — forge Rules The Forge provided ecosystem rules available item
forgeRules (anyOf 2)	null	Alternative
projectTypes	JSON	Optional
projectTypes (anyOf 1)	array	Alternative	The types of projects that this capability set is available for.
projectTypes (anyOf 1)[]	string	Each item	Known values: software, service_desk, product_discovery, business, unknown
projectTypes (anyOf 2)	null	Alternative
systemRules	JSON	Optional
systemRules (anyOf 1)	array	Alternative	The Atlassian provided system rules available.
systemRules (anyOf 1)[]	Model	Each item	Expand Get available workflow capabilities — response body — system Rules The Atlassian provided system rules available item
systemRules (anyOf 2)	null	Alternative
triggerRules	JSON	Optional
triggerRules (anyOf 1)	array	Alternative	The trigger rules available.
triggerRules (anyOf 1)[]	Model	Each item	Expand Get available workflow capabilities — response body — trigger Rules The trigger rules available item
triggerRules (anyOf 2)	null	Alternative

Referenced models: Get available workflow capabilities — response body — connect Rules The Connect provided ecosystem rules available item, Get available workflow capabilities — response body — forge Rules The Forge provided ecosystem rules available item, Get available workflow capabilities — response body — system Rules The Atlassian provided system rules available item, Get available workflow capabilities — response body — trigger Rules The trigger rules available item

Get available workflow capabilities — response body — connect Rules The Connect provided ecosystem rules available item

Field	Type	Presence	Description and constraints
$	object	Root	The Connect provided ecosystem rules available.
addonKey	JSON	Optional
addonKey (anyOf 1)	string	Alternative	The add-on providing the rule.
addonKey (anyOf 2)	null	Alternative
createUrl	JSON	Optional
createUrl (anyOf 1)	string	Alternative	The URL creation path segment defined in the Connect module.
createUrl (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative	The rule description.
description (anyOf 2)	null	Alternative
editUrl	JSON	Optional
editUrl (anyOf 1)	string	Alternative	The URL edit path segment defined in the Connect module.
editUrl (anyOf 2)	null	Alternative
moduleKey	JSON	Optional
moduleKey (anyOf 1)	string	Alternative	The module providing the rule.
moduleKey (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The rule name.
name (anyOf 2)	null	Alternative
ruleKey	JSON	Optional
ruleKey (anyOf 1)	string	Alternative	The rule key.
ruleKey (anyOf 2)	null	Alternative
ruleType	JSON	Optional
ruleType (anyOf 1)	string	Alternative	The rule type. Known values: Condition, Validator, Function, Screen
ruleType (anyOf 2)	null	Alternative
viewUrl	JSON	Optional
viewUrl (anyOf 1)	string	Alternative	The URL view path segment defined in the Connect module.
viewUrl (anyOf 2)	null	Alternative

Get available workflow capabilities — response body — forge Rules The Forge provided ecosystem rules available item

Field	Type	Presence	Description and constraints
$	object	Root	The Forge provided ecosystem rules available.
description	JSON	Optional
description (anyOf 1)	string	Alternative	The rule description.
description (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative	The unique ARI of the forge rule type.
id (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The rule name.
name (anyOf 2)	null	Alternative
ruleKey	JSON	Optional
ruleKey (anyOf 1)	string	Alternative	The rule key.
ruleKey (anyOf 2)	null	Alternative
ruleType	JSON	Optional
ruleType (anyOf 1)	string	Alternative	The rule type. Known values: Condition, Validator, Function, Screen
ruleType (anyOf 2)	null	Alternative

Get available workflow capabilities — response body — system Rules The Atlassian provided system rules available item

Field	Type	Presence	Description and constraints
$	object	Root	The Atlassian provided system rules available.
description	JSON	Optional
description (anyOf 1)	string	Alternative	The rule description.
description (anyOf 2)	null	Alternative
incompatibleRuleKeys	JSON	Optional
incompatibleRuleKeys (anyOf 1)	array	Alternative	List of rules that conflict with this one.
incompatibleRuleKeys (anyOf 1)[]	string	Each item	List of rules that conflict with this one.
incompatibleRuleKeys (anyOf 2)	null	Alternative
isAvailableForInitialTransition	JSON	Optional
isAvailableForInitialTransition (anyOf 1)	boolean	Alternative	Whether the rule can be added added to an initial transition.
isAvailableForInitialTransition (anyOf 2)	null	Alternative
isVisible	JSON	Optional
isVisible (anyOf 1)	boolean	Alternative	Whether the rule is visible.
isVisible (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The rule name.
name (anyOf 2)	null	Alternative
ruleKey	JSON	Optional
ruleKey (anyOf 1)	string	Alternative	The rule key.
ruleKey (anyOf 2)	null	Alternative
ruleType	JSON	Optional
ruleType (anyOf 1)	string	Alternative	The rule type. Known values: Condition, Validator, Function, Screen
ruleType (anyOf 2)	null	Alternative

Get available workflow capabilities — response body — trigger Rules The trigger rules available item

Field	Type	Presence	Description and constraints
$	object	Root	The trigger rules available.
availableTypes	JSON	Optional
availableTypes (anyOf 1)	array	Alternative	The list of available trigger types.
availableTypes (anyOf 1)[]	Model	Each item	Expand Get available workflow capabilities — response body — trigger Rules The trigger rules available item available Types The list of available trigger types item
availableTypes (anyOf 2)	null	Alternative
ruleKey	JSON	Optional
ruleKey (anyOf 1)	string	Alternative	The rule key of the rule.
ruleKey (anyOf 2)	null	Alternative

Referenced models: Get available workflow capabilities — response body — trigger Rules The trigger rules available item available Types The list of available trigger types item

Get available workflow capabilities — response body — trigger Rules The trigger rules available item available Types The list of available trigger types item

Field	Type	Presence	Description and constraints
$	object	Root	The list of available trigger types.
description	JSON	Optional
description (anyOf 1)	string	Alternative	The description of the trigger rule.
description (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the trigger rule.
name (anyOf 2)	null	Alternative
type	JSON	Optional
type (anyOf 1)	string	Alternative	The type identifier of trigger rule.
type (anyOf 2)	null	Alternative

Get issue types in a project that are using a given workflow — response body

Field	Type	Presence	Description and constraints
$	object	Root	Issue types associated with the workflow for a project.
issueTypes	JSON	Optional
issueTypes (anyOf 1)	Model	Alternative	Expand Get issue types in a project that are using a given workflow — response body — issue Types A page of issue types
issueTypes (anyOf 2)	null	Alternative
projectId	JSON	Optional
projectId (anyOf 1)	string	Alternative	The ID of the project.
projectId (anyOf 2)	null	Alternative
workflowId	JSON	Optional
workflowId (anyOf 1)	string	Alternative	The ID of the workflow.
workflowId (anyOf 2)	null	Alternative

Referenced models: Get issue types in a project that are using a given workflow — response body — issue Types A page of issue types

Get issue types in a project that are using a given workflow — 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	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 types in a project that are using a given workflow — 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 types in a project that are using a given workflow — response body — issue Types A page of issue types values The list of issue types item

Get issue types in a project that are using a given workflow — 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 issue type.
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the issue type.
id (anyOf 2)	null	Alternative

Get projects using a given workflow — response body

Field	Type	Presence	Description and constraints
$	object	Root	Projects using the workflow.
projects	JSON	Optional
projects (anyOf 1)	Model	Alternative	Expand Get projects using a given workflow — response body — projects A page of projects
projects (anyOf 2)	null	Alternative
workflowId	JSON	Optional
workflowId (anyOf 1)	string	Alternative	The workflow ID.
workflowId (anyOf 2)	null	Alternative

Referenced models: Get projects using a given workflow — response body — projects A page of projects

Get projects using a given workflow — 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 project 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 the user's default workflow editor — response body

Field	Type	Presence	Description and constraints
$	object	Root
value	JSON	Optional
value (anyOf 1)	string	Alternative	Known values: NEW, LEGACY
value (anyOf 2)	null	Alternative

Get workflow schemes which are using a given workflow — response body

Field	Type	Presence	Description and constraints
$	object	Root	Workflow schemes using the workflow.
workflowId	JSON	Optional
workflowId (anyOf 1)	string	Alternative	The workflow ID.
workflowId (anyOf 2)	null	Alternative
workflowSchemes	JSON	Optional
workflowSchemes (anyOf 1)	Model	Alternative	Expand Get workflow schemes which are using a given workflow — response body — workflow Schemes A page of workflow schemes
workflowSchemes (anyOf 2)	null	Alternative

Referenced models: Get workflow schemes which are using a given workflow — response body — workflow Schemes A page of workflow schemes

Get workflow schemes which are using a given workflow — response body — workflow Schemes A page of workflow schemes

Field	Type	Presence	Description and constraints
$	object	Root	A page of workflow schemes.
nextPageToken	JSON	Optional
nextPageToken (anyOf 1)	string	Alternative	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 workflow schemes.
values (anyOf 1)[]	Model	Each item	Expand Get workflow schemes which are using a given workflow — response body — workflow Schemes A page of workflow schemes values The list of workflow schemes item
values (anyOf 2)	null	Alternative

Referenced models: Get workflow schemes which are using a given workflow — response body — workflow Schemes A page of workflow schemes values The list of workflow schemes item

Get workflow schemes which are using a given workflow — response body — workflow Schemes A page of workflow schemes values The list of workflow schemes item

Field	Type	Presence	Description and constraints
$	object	Root	The worflow scheme.
id	JSON	Optional
id (anyOf 1)	string	Alternative	The workflow scheme ID.
id (anyOf 2)	null	Alternative

Get workflows paginated — 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 workflows paginated — response body — values The list of items item
values (anyOf 2)	null	Alternative

Referenced models: Get workflows paginated — response body — values The list of items item

Get workflows paginated — response body — values The list of items item

Field	Type	Presence	Description and constraints
$	object	Root	Details about 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)	integer	Alternative
created (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative	The description of the workflow.
description (anyOf 2)	null	Alternative
hasDraftWorkflow	JSON	Optional
hasDraftWorkflow (anyOf 1)	boolean	Alternative	Whether the workflow has a draft version.
hasDraftWorkflow (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	Model	Alternative	Expand Get workflows paginated — response body — values The list of items item id Properties that identify a published workflow
id (anyOf 2)	null	Alternative
isDefault	JSON	Optional
isDefault (anyOf 1)	boolean	Alternative	Whether this is the default workflow.
isDefault (anyOf 2)	null	Alternative
operations	JSON	Optional
operations (anyOf 1)	Model	Alternative	Expand Get workflows paginated — response body — values The list of items item operations Operations allowed on a workflow
operations (anyOf 2)	null	Alternative
projects	JSON	Optional
projects (anyOf 1)	array	Alternative	The projects the workflow is assigned to, through workflow schemes.
projects (anyOf 1)[]	Model	Each item	Expand Get issue type screen scheme projects — response body — values The list of items item
projects (anyOf 2)	null	Alternative
schemes	JSON	Optional
schemes (anyOf 1)	array	Alternative	The workflow schemes the workflow is assigned to.
schemes (anyOf 1)[]	Model	Each item	Expand Get workflows paginated — response body — values The list of items item schemes The workflow schemes the workflow is assigned to item
schemes (anyOf 2)	null	Alternative
statuses	JSON	Optional
statuses (anyOf 1)	array	Alternative	The statuses of the workflow.
statuses (anyOf 1)[]	Model	Each item	Expand Get workflows paginated — response body — values The list of items item statuses The statuses of the workflow item
statuses (anyOf 2)	null	Alternative
transitions	JSON	Optional
transitions (anyOf 1)	array	Alternative	The transitions of the workflow.
transitions (anyOf 1)[]	Model	Each item	Expand Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow 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)	integer	Alternative
updated (anyOf 2)	null	Alternative

Referenced models: Get issue type screen scheme projects — response body — values The list of items item, Get workflows paginated — response body — values The list of items item id Properties that identify a published workflow, Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item, Get workflows paginated — response body — values The list of items item operations Operations allowed on a workflow, Get workflows paginated — response body — values The list of items item schemes The workflow schemes the workflow is assigned to item, Get workflows paginated — response body — values The list of items item statuses The statuses of the workflow item

Get workflows paginated — response body — values The list of items item id Properties that identify a published workflow

Field	Type	Presence	Description and constraints
$	object	Root	Properties that identify a published workflow.
entityId	JSON	Optional
entityId (anyOf 1)	string	Alternative	The entity ID of the workflow.
entityId (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the workflow.
name (anyOf 2)	null	Alternative

Get workflows paginated — response body — values The list of items item operations Operations allowed on a workflow

Field	Type	Presence	Description and constraints
$	object	Root	Operations allowed on a workflow
canDelete	JSON	Optional
canDelete (anyOf 1)	boolean	Alternative	Whether the workflow can be deleted.
canDelete (anyOf 2)	null	Alternative
canEdit	JSON	Optional
canEdit (anyOf 1)	boolean	Alternative	Whether the workflow can be updated.
canEdit (anyOf 2)	null	Alternative

Get workflows paginated — response body — values The list of items item schemes The workflow schemes the workflow is assigned to item

Field	Type	Presence	Description and constraints
$	object	Root	The ID and the name of the workflow scheme.
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the workflow scheme.
id (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the workflow scheme.
name (anyOf 2)	null	Alternative

Get workflows paginated — response body — values The list of items item statuses The statuses of the workflow item

Field	Type	Presence	Description and constraints
$	object	Root	Details of a workflow status.
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the issue status.
id (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the status in the workflow.
name (anyOf 2)	null	Alternative
properties	JSON	Optional
properties (anyOf 1)	object	Alternative	Additional properties that modify the behavior of issues in this status. Supports the properties `jira.issue.editable` and `issueEditable` (deprecated) that indicate whether issues are editable. Additional keys: see wildcard field
properties (anyOf 1).*	JSON	Additional keys	Additional properties that modify the behavior of issues in this status. Supports the properties <code>jira.issue.editable</code> and <code>issueEditable</code> (deprecated) that indicate whether issues are editable.
properties (anyOf 2)	null	Alternative

Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item

Field	Type	Presence	Description and constraints
$	object	Root	Details of a workflow transition.
description	JSON	Optional
description (anyOf 1)	string	Alternative	The description of the transition.
description (anyOf 2)	null	Alternative
from	JSON	Optional
from (anyOf 1)	array	Alternative	The statuses the transition can start from.
from (anyOf 1)[]	string	Each item	The statuses the transition can start from.
from (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the transition.
id (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the transition.
name (anyOf 2)	null	Alternative
properties	JSON	Optional
properties (anyOf 1)	object	Alternative	The properties of the transition. Additional keys: see wildcard field
properties (anyOf 1).*	JSON	Additional keys	The properties of the transition.
properties (anyOf 2)	null	Alternative
rules	JSON	Optional
rules (anyOf 1)	Model	Alternative	Expand Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item rules A collection of transition rules
rules (anyOf 2)	null	Alternative
screen	JSON	Optional
screen (anyOf 1)	Model	Alternative	Expand Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item screen The details of a transition screen
screen (anyOf 2)	null	Alternative
to	JSON	Optional
to (anyOf 1)	string	Alternative	The status the transition goes to.
to (anyOf 2)	null	Alternative
type	JSON	Optional
type (anyOf 1)	string	Alternative	The type of the transition. Known values: global, initial, directed
type (anyOf 2)	null	Alternative

Referenced models: Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item screen The details of a transition screen, Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item rules A collection of transition rules

Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item rules A collection of transition rules

Field	Type	Presence	Description and constraints
$	object	Root	A collection of transition rules.
conditionsTree	JSON	Optional
conditionsTree (anyOf 1)	Model	Alternative	Expand Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item rules A collection of transition rules conditions Tree The workflow transition rule conditions tree
conditionsTree (anyOf 2)	null	Alternative
postFunctions	JSON	Optional
postFunctions (anyOf 1)	array	Alternative	The workflow post functions.
postFunctions (anyOf 1)[]	Model	Each item	Expand Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item rules A collection of transition rules validators The workflow validators item
postFunctions (anyOf 2)	null	Alternative
validators	JSON	Optional
validators (anyOf 1)	array	Alternative	The workflow validators.
validators (anyOf 1)[]	Model	Each item	Expand Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item rules A collection of transition rules validators The workflow validators item
validators (anyOf 2)	null	Alternative

Referenced models: Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item rules A collection of transition rules conditions Tree The workflow transition rule conditions tree, Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item rules A collection of transition rules validators The workflow validators item

Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item rules A collection of transition rules conditions Tree The workflow transition rule conditions tree

Field	Type	Presence	Description and constraints
$	object	Root	The workflow transition rule conditions tree. discriminator: {"mapping": {"compound": "#/components/schemas/WorkflowCompoundCondition", "simple": "#/components/schemas/WorkflowSimpleCondition"}, "propertyName": "nodeType"}
$ (anyOf 1)	Model	Alternative	Expand Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item rules A collection of transition rules conditions Tree The workflow transition rule conditions tree node Type simple
$ (anyOf 2)	Model	Alternative	Expand Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item rules A collection of transition rules conditions Tree The workflow transition rule conditions tree node Type compound

Referenced models: Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item rules A collection of transition rules conditions Tree The workflow transition rule conditions tree node Type compound, Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item rules A collection of transition rules conditions Tree The workflow transition rule conditions tree node Type simple

Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item rules A collection of transition rules conditions Tree The workflow transition rule conditions tree node Type compound

Field	Type	Presence	Description and constraints
$	object	Root	A compound workflow transition rule condition. This object returns `nodeType` as `compound`.
conditions	JSON	Optional
conditions (anyOf 1)	array	Alternative	The list of workflow conditions.
conditions (anyOf 1)[]	Model	Each item	Expand Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item rules A collection of transition rules conditions Tree The workflow transition rule conditions tree
conditions (anyOf 2)	null	Alternative
nodeType	string	Optional	Must equal: compound
operator	JSON	Optional
operator (anyOf 1)	string	Alternative	The compound condition operator. Known values: AND, OR
operator (anyOf 2)	null	Alternative

Referenced models: Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item rules A collection of transition rules conditions Tree The workflow transition rule conditions tree

Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item rules A collection of transition rules conditions Tree The workflow transition rule conditions tree node Type simple

Field	Type	Presence	Description and constraints
$	object	Root	A workflow transition rule condition. This object returns `nodeType` as `simple`.
configuration	JSON	Optional
configuration (anyOf 1)	object	Alternative	EXPERIMENTAL. The configuration of the transition rule.
configuration (anyOf 2)	null	Alternative
nodeType	string	Optional	Must equal: simple
type	JSON	Optional
type (anyOf 1)	string	Alternative	The type of the transition rule.
type (anyOf 2)	null	Alternative

Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item rules A collection of transition rules validators The workflow validators item

Field	Type	Presence	Description and constraints
$	object	Root	A workflow transition rule.
configuration	JSON	Optional
configuration (anyOf 1)	JSON	Alternative	EXPERIMENTAL. The configuration of the transition rule.
configuration (anyOf 2)	null	Alternative
type	JSON	Optional
type (anyOf 1)	string	Alternative	The type of the transition rule.
type (anyOf 2)	null	Alternative

Get workflows paginated — response body — values The list of items item transitions The transitions of the workflow item screen The details of a transition screen

Field	Type	Presence	Description and constraints
$	object	Root	The details of a transition screen.
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the screen.
id (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the screen.
name (anyOf 2)	null	Alternative

List workflow history entries — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	A request to read all the workflow history entries for a specific workflow. Additional keys: not allowed
workflowId	string	Optional	The id of the workflow to read the history for.

List workflow history entries — response body

Field	Type	Presence	Description and constraints
$	object	Root	A list of workflow history entries.
entries	JSON	Optional
entries (anyOf 1)	array	Alternative
entries (anyOf 1)[]	Model	Each item	Expand List workflow history entries — response body — entries array item
entries (anyOf 2)	null	Alternative

Referenced models: List workflow history entries — response body — entries array item

List workflow history entries — response body — entries array item

Field	Type	Presence	Description and constraints
$	object	Root	A single entry in the WorkflowHistoryPage.
isIntermediate	JSON	Optional
isIntermediate (anyOf 1)	boolean	Alternative	Whether the version is an intermediate workflow state, sometimes created during workflow updates.
isIntermediate (anyOf 2)	null	Alternative
workflowId	JSON	Optional
workflowId (anyOf 1)	string	Alternative
workflowId (anyOf 2)	null	Alternative
workflowVersion	JSON	Optional
workflowVersion (anyOf 1)	JSON	Alternative
workflowVersion (anyOf 1) (anyOf 1)	integer	Alternative	Format: int64
workflowVersion (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
workflowVersion (anyOf 2)	null	Alternative
writtenAt	JSON	Optional
writtenAt (anyOf 1)	string	Alternative	The timestamp when this workflow version was created.
writtenAt (anyOf 2)	null	Alternative

Preview workflow — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	The details of the preview workflow request. Additional keys: not allowed
issueTypeIds	array	Optional	The list of issue type IDs. At most 25 issue type IDs can be specified. Maximum items: 25 Minimum items: 0
issueTypeIds[]	string	Each item	The list of issue type IDs. At most 25 issue type IDs can be specified.
projectId	string	Required within parent	The projectId parameter is required and will be used for permission checks. In addition, you must supply at least one of the following lookup terms: *workflowNames*, *workflowIds*, or *issueTypeIds*. The specified workflows must be associated with the given project.
workflowIds	array	Optional	The list of workflow IDs to be returned. At most 25 workflow IDs can be specified. Maximum items: 25 Minimum items: 0
workflowIds[]	string	Each item	The list of workflow IDs to be returned. At most 25 workflow IDs can be specified.
workflowNames	array	Optional	The list of workflow names to be returned. At most 25 workflow names can be specified. Maximum items: 25 Minimum items: 0
workflowNames[]	string	Each item	The list of workflow names to be returned. At most 25 workflow names can be specified.

Preview workflow — response body

Field	Type	Presence	Description and constraints
$	object	Root	The preview workflow response containing workflows and statuses.
statuses	JSON	Optional
statuses (anyOf 1)	array	Alternative	The list of statuses referenced by the workflows.
statuses (anyOf 1)[]	Model	Each item	Expand Preview workflow — response body — statuses The list of statuses referenced by the workflows item
statuses (anyOf 2)	null	Alternative
workflows	JSON	Optional
workflows (anyOf 1)	array	Alternative	The list of workflows. The workflows are returned in the same order as specified in the request.
workflows (anyOf 1)[]	Model	Each item	Expand Preview workflow — response body — workflows array item
workflows (anyOf 2)	null	Alternative

Referenced models: Preview workflow — response body — statuses The list of statuses referenced by the workflows item, Preview workflow — response body — workflows array item

Preview workflow — response body — statuses The list of statuses referenced by the workflows 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
rawName	JSON	Optional
rawName (anyOf 1)	string	Alternative	The raw name of the status.
rawName (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
statusCategory	JSON	Optional
statusCategory (anyOf 1)	string	Alternative	The category of the status. Known values: TODO, IN_PROGRESS, DONE
statusCategory (anyOf 2)	null	Alternative
statusReference	JSON	Optional
statusReference (anyOf 1)	string	Alternative	The reference of the status. Unique within this response but not guaranteed to be stable across requests.
statusReference (anyOf 2)	null	Alternative

Referenced models: Bulk get workflow schemes — response body — item scope The scope of the workflow

Preview workflow — response body — workflows array item

Field	Type	Presence	Description and constraints
$	object	Root	Details of a workflow.
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
loopedTransitionContainerLayout	JSON	Optional
loopedTransitionContainerLayout (anyOf 1)	Model	Alternative	Expand Preview workflow — response body — workflows array item start Point Layout Layout coordinates for workflow elements
loopedTransitionContainerLayout (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the workflow.
name (anyOf 2)	null	Alternative
queryContext	JSON	Optional
queryContext (anyOf 1)	array	Alternative	The project and issue type context for this workflow query.
queryContext (anyOf 1)[]	Model	Each item	Expand Preview workflow — response body — workflows array item query Context array item
queryContext (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 Preview workflow — response body — workflows array item start Point Layout Layout coordinates for workflow elements
startPointLayout (anyOf 2)	null	Alternative
statuses	JSON	Optional
statuses (anyOf 1)	array	Alternative	The statuses referenced in this workflow.
statuses (anyOf 1)[]	Model	Each item	Expand Preview workflow — response body — workflows array item statuses The statuses referenced in this workflow item
statuses (anyOf 2)	null	Alternative
transitions	JSON	Optional
transitions (anyOf 1)	array	Alternative	The transitions of the workflow.
transitions (anyOf 1)[]	Model	Each item	Expand Preview workflow — response body — workflows array item transitions The transitions of the workflow item
transitions (anyOf 2)	null	Alternative
version	JSON	Optional
version (anyOf 1)	Model	Alternative	Expand Preview workflow — response body — workflows array item version The version details of the workflow
version (anyOf 2)	null	Alternative

Referenced models: Preview workflow — response body — workflows array item query Context array item, Preview workflow — response body — workflows array item transitions The transitions of the workflow item, Preview workflow — response body — workflows array item version The version details of the workflow, Preview workflow — response body — workflows array item start Point Layout Layout coordinates for workflow elements, Bulk get workflow schemes — response body — item scope The scope of the workflow, Preview workflow — response body — workflows array item statuses The statuses referenced in this workflow item

Preview workflow — response body — workflows array item query Context array item

Field	Type	Presence	Description and constraints
$	object	Root	Project and issue type context for workflow queries made using issue types.
issueTypes	JSON	Optional
issueTypes (anyOf 1)	array	Alternative	The set of issue type IDs.
issueTypes (anyOf 1)[]	string	Each item	The set of issue type IDs.
issueTypes (anyOf 2)	null	Alternative
project	JSON	Optional
project (anyOf 1)	string	Alternative	The ID of the project.
project (anyOf 2)	null	Alternative

Preview workflow — response body — workflows array item start Point Layout Layout coordinates for workflow elements

Field	Type	Presence	Description and constraints
$	object	Root	Layout coordinates for workflow elements.
x	JSON	Optional
x (anyOf 1)	JSON	Alternative
x (anyOf 1) (anyOf 1)	number	Alternative	The X coordinate. Format: double
x (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
x (anyOf 2)	null	Alternative
y	JSON	Optional
y (anyOf 1)	JSON	Alternative
y (anyOf 1) (anyOf 1)	number	Alternative	The Y coordinate. Format: double
y (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
y (anyOf 2)	null	Alternative

Preview workflow — response body — workflows array item statuses The statuses referenced in this workflow item

Field	Type	Presence	Description and constraints
$	object	Root	Details about a workflow status in preview context.
approvalConfiguration	JSON	Optional
approvalConfiguration (anyOf 1)	Model	Alternative	Expand Preview workflow — response body — workflows array item statuses The statuses referenced in this workflow item approval Configuration Approval configuration
approvalConfiguration (anyOf 2)	null	Alternative
deprecated	JSON	Optional
deprecated (anyOf 1)	boolean	Alternative	Whether the status is deprecated.
deprecated (anyOf 2)	null	Alternative
layout	JSON	Optional
layout (anyOf 1)	Model	Alternative	Expand Preview workflow — response body — workflows array item start Point Layout Layout coordinates for workflow elements
layout (anyOf 2)	null	Alternative
statusReference	JSON	Optional
statusReference (anyOf 1)	string	Alternative	The reference of the status.
statusReference (anyOf 2)	null	Alternative

Referenced models: Preview workflow — response body — workflows array item statuses The statuses referenced in this workflow item approval Configuration Approval configuration, Preview workflow — response body — workflows array item start Point Layout Layout coordinates for workflow elements

Preview workflow — response body — workflows array item statuses The statuses referenced in this workflow item approval Configuration Approval configuration

Field	Type	Presence	Description and constraints
$	object	Root	Approval configuration.
active	JSON	Optional
active (anyOf 1)	string	Alternative	The active approval configuration.
active (anyOf 2)	null	Alternative
transitionApproved	JSON	Optional
transitionApproved (anyOf 1)	string	Alternative	The transition ID for approved state.
transitionApproved (anyOf 2)	null	Alternative
transitionRejected	JSON	Optional
transitionRejected (anyOf 1)	string	Alternative	The transition ID for rejected state.
transitionRejected (anyOf 2)	null	Alternative

Preview workflow — response body — workflows array item transitions The transitions of the workflow item

Field	Type	Presence	Description and constraints
$	object	Root	Details about a workflow transition in preview context.
actions	JSON	Optional
actions (anyOf 1)	array	Alternative	The post-functions of the transition.
actions (anyOf 1)[]	Model	Each item	Expand Preview workflow — response body — workflows array item transitions The transitions of the workflow item transition Screen value
actions (anyOf 2)	null	Alternative
conditions	JSON	Optional
conditions (anyOf 1)	Model	Alternative	Expand Preview workflow — response body — workflows array item transitions The transitions of the workflow item conditions value
conditions (anyOf 2)	null	Alternative
customIssueEventId	JSON	Optional
customIssueEventId (anyOf 1)	string	Alternative	The custom issue event ID for the transition.
customIssueEventId (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative	The description of the transition.
description (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the transition.
id (anyOf 2)	null	Alternative
links	JSON	Optional
links (anyOf 1)	array	Alternative	The statuses the transition can start from, and the mapping of ports between the statuses.
links (anyOf 1)[]	Model	Each item	Expand Preview workflow — response body — workflows array item transitions The transitions of the workflow item links array item
links (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the transition.
name (anyOf 2)	null	Alternative
toStatusReference	JSON	Optional
toStatusReference (anyOf 1)	string	Alternative	The status the transition goes to.
toStatusReference (anyOf 2)	null	Alternative
transitionScreen	JSON	Optional
transitionScreen (anyOf 1)	Model	Alternative	Expand Preview workflow — response body — workflows array item transitions The transitions of the workflow item transition Screen value
transitionScreen (anyOf 2)	null	Alternative
triggers	JSON	Optional
triggers (anyOf 1)	array	Alternative	The triggers of the transition.
triggers (anyOf 1)[]	Model	Each item	Expand Preview workflow — response body — workflows array item transitions The transitions of the workflow item triggers The triggers of the transition item
triggers (anyOf 2)	null	Alternative
type	JSON	Optional
type (anyOf 1)	string	Alternative	The transition type. Known values: INITIAL, GLOBAL, DIRECTED
type (anyOf 2)	null	Alternative
validators	JSON	Optional
validators (anyOf 1)	array	Alternative	The validators of the transition.
validators (anyOf 1)[]	Model	Each item	Expand Preview workflow — response body — workflows array item transitions The transitions of the workflow item transition Screen value
validators (anyOf 2)	null	Alternative

Referenced models: Preview workflow — response body — workflows array item transitions The transitions of the workflow item conditions value, Preview workflow — response body — workflows array item transitions The transitions of the workflow item transition Screen value, Preview workflow — response body — workflows array item transitions The transitions of the workflow item triggers The triggers of the transition item, Preview workflow — response body — workflows array item transitions The transitions of the workflow item links array item

Preview workflow — response body — workflows array item transitions The transitions of the workflow item conditions value

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Condition group configuration for workflow transitions.
$ (anyOf 1).conditionGroups	JSON	Optional
$ (anyOf 1).conditionGroups (anyOf 1)	array	Alternative	The nested conditions of the condition group.
$ (anyOf 1).conditionGroups (anyOf 1)[]	Model	Each item	Expand Preview workflow — response body — workflows array item transitions The transitions of the workflow item conditions value
$ (anyOf 1).conditionGroups (anyOf 2)	null	Alternative
$ (anyOf 1).conditions	JSON	Optional
$ (anyOf 1).conditions (anyOf 1)	array	Alternative	The rules for this condition.
$ (anyOf 1).conditions (anyOf 1)[]	Model	Each item	Expand Preview workflow — response body — workflows array item transitions The transitions of the workflow item transition Screen value
$ (anyOf 1).conditions (anyOf 2)	null	Alternative
$ (anyOf 1).operation	JSON	Optional
$ (anyOf 1).operation (anyOf 1)	string	Alternative	Determines how the conditions in the group are evaluated. Accepts either `ANY` or `ALL`. If `ANY` is used, at least one condition in the group must be true for the group to evaluate to true. If `ALL` is used, all conditions in the group must be true for the group to evaluate to true. Known values: ANY, ALL
$ (anyOf 1).operation (anyOf 2)	null	Alternative
$ (anyOf 2)	null	Alternative

Referenced models: Preview workflow — response body — workflows array item transitions The transitions of the workflow item conditions value, Preview workflow — response body — workflows array item transitions The transitions of the workflow item transition Screen value

Preview workflow — response body — workflows array item transitions The transitions of the workflow item links array item

Field	Type	Presence	Description and constraints
$	object	Root	Link information for workflow transitions.
fromPort	JSON	Optional
fromPort (anyOf 1)	JSON	Alternative
fromPort (anyOf 1) (anyOf 1)	integer	Alternative	The from port number. Format: int32
fromPort (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fromPort (anyOf 2)	null	Alternative
fromStatusReference	JSON	Optional
fromStatusReference (anyOf 1)	string	Alternative	The from status reference.
fromStatusReference (anyOf 2)	null	Alternative
toPort	JSON	Optional
toPort (anyOf 1)	JSON	Alternative
toPort (anyOf 1) (anyOf 1)	integer	Alternative	The to port number. Format: int32
toPort (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
toPort (anyOf 2)	null	Alternative

Preview workflow — response body — workflows array item transitions The transitions of the workflow item transition Screen value

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Rule configuration for workflow transitions.
$ (anyOf 1).id	JSON	Optional
$ (anyOf 1).id (anyOf 1)	string	Alternative	A transient identifier for this element, unique within this response but not guaranteed to stable across requests.
$ (anyOf 1).id (anyOf 2)	null	Alternative
$ (anyOf 1).parameters	JSON	Optional
$ (anyOf 1).parameters (anyOf 1)	object	Alternative	The parameters of the rule. Additional keys: see wildcard field
$ (anyOf 1).parameters (anyOf 1).*	string	Additional keys	The parameters of the rule.
$ (anyOf 1).parameters (anyOf 2)	null	Alternative
$ (anyOf 1).ruleKey	JSON	Optional
$ (anyOf 1).ruleKey (anyOf 1)	string	Alternative	The rule key of the rule.
$ (anyOf 1).ruleKey (anyOf 2)	null	Alternative
$ (anyOf 2)	null	Alternative

Preview workflow — response body — workflows array item transitions The transitions of the workflow item triggers The triggers of the transition item

Field	Type	Presence	Description and constraints
$	object	Root	Trigger configuration for workflow transitions.
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the trigger.
id (anyOf 2)	null	Alternative
ruleKey	JSON	Optional
ruleKey (anyOf 1)	string	Alternative	The key of the trigger rule.
ruleKey (anyOf 2)	null	Alternative

Preview workflow — response body — workflows array item version The version details of the workflow

Field	Type	Presence	Description and constraints
$	object	Root	The version details of the workflow.
id	JSON	Optional
id (anyOf 1)	string	Alternative	The version UUID.
id (anyOf 2)	null	Alternative
versionNumber	JSON	Optional
versionNumber (anyOf 1)	JSON	Alternative
versionNumber (anyOf 1) (anyOf 1)	integer	Alternative	The version number. Format: int64
versionNumber (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
versionNumber (anyOf 2)	null	Alternative

Read workflow version from history — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	A request to read a specific workflow version from history. Additional keys: not allowed
version	integer	Optional	Format: int64
workflowId	string	Optional

Read workflow version from history — response body

Field	Type	Presence	Description and constraints
$	object	Root	The specified workflow version read from history.
statuses	JSON	Optional
statuses (anyOf 1)	array	Alternative	Unique items: true
statuses (anyOf 1)[]	Model	Each item	Expand Read workflow version from history — response body — statuses array item
statuses (anyOf 2)	null	Alternative
workflows	JSON	Optional
workflows (anyOf 1)	array	Alternative	Unique items: true
workflows (anyOf 1)[]	Model	Each item	Expand Read workflow version from history — response body — workflows array item
workflows (anyOf 2)	null	Alternative

Referenced models: Read workflow version from history — response body — workflows array item, Read workflow version from history — response body — statuses array item

Read workflow version from history — response body — statuses array item

Field	Type	Presence	Description and constraints
$	object	Root	The statuses stored for the specified version.
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative
id (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative
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
statusCategory	JSON	Optional
statusCategory (anyOf 1)	string	Alternative
statusCategory (anyOf 2)	null	Alternative
statusReference	JSON	Optional
statusReference (anyOf 1)	string	Alternative
statusReference (anyOf 2)	null	Alternative

Referenced models: Bulk get workflow schemes — response body — item scope The scope of the workflow

Read workflow version from history — response body — workflows array item

Field	Type	Presence	Description and constraints
$	object	Root	The workflow stored for the specified version.
created	JSON	Optional
created (anyOf 1)	string	Alternative
created (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative
id (anyOf 2)	null	Alternative
lastUpdateAuthorAAID	JSON	Optional
lastUpdateAuthorAAID (anyOf 1)	string	Alternative
lastUpdateAuthorAAID (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
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	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
transitions	JSON	Optional
transitions (anyOf 1)	array	Alternative	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)	string	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

Read workflow version from history — response body — workflows array item start Point Layout value

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	The starting point for the statuses in the workflow.
$ (anyOf 1).x	JSON	Optional
$ (anyOf 1).x (anyOf 1)	JSON	Alternative
$ (anyOf 1).x (anyOf 1) (anyOf 1)	number	Alternative	The x axis location. Format: double
$ (anyOf 1).x (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).x (anyOf 2)	null	Alternative
$ (anyOf 1).y	JSON	Optional
$ (anyOf 1).y (anyOf 1)	JSON	Alternative
$ (anyOf 1).y (anyOf 1) (anyOf 1)	number	Alternative	The y axis location. Format: double
$ (anyOf 1).y (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).y (anyOf 2)	null	Alternative
$ (anyOf 2)	null	Alternative

Read workflow version from history — response body — workflows array item statuses array item

Field	Type	Presence	Description and constraints
$	object	Root	The statuses referenced in the workflow.
approvalConfiguration	JSON	Optional
approvalConfiguration (anyOf 1)	Model	Alternative	Expand Read workflow version from history — response body — workflows array item statuses array item approval Configuration value
approvalConfiguration (anyOf 2)	null	Alternative
deprecated	JSON	Optional
deprecated (anyOf 1)	boolean	Alternative	Indicates if the status is deprecated.
deprecated (anyOf 2)	null	Alternative
layout	JSON	Optional
layout (anyOf 1)	Model	Alternative	Expand Read workflow version from history — response body — workflows array item statuses array item layout value
layout (anyOf 2)	null	Alternative
properties	JSON	Optional
properties (anyOf 1)	object	Alternative	The properties associated with the status. Additional keys: see wildcard field
properties (anyOf 1).*	string	Additional keys	The properties associated with the status.
properties (anyOf 2)	null	Alternative
statusReference	JSON	Optional
statusReference (anyOf 1)	string	Alternative	The reference of the status.
statusReference (anyOf 2)	null	Alternative

Referenced models: Read workflow version from history — response body — workflows array item statuses array item approval Configuration value, Read workflow version from history — response body — workflows array item statuses array item layout value

Read workflow version from history — response body — workflows array item statuses array item approval Configuration value

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	The approval configuration of a status within a workflow. Applies only to Jira Service Management approvals.
$ (anyOf 1).active	JSON	Optional
$ (anyOf 1).active (anyOf 1)	string	Alternative	Whether the approval configuration is active. Known values: true, false
$ (anyOf 1).active (anyOf 2)	null	Alternative
$ (anyOf 1).conditionType	JSON	Optional
$ (anyOf 1).conditionType (anyOf 1)	string	Alternative	How the required approval count is calculated. It may be configured to require a specific number of approvals, or approval by a percentage of approvers. If the approvers source field is Approver groups, you can configure how many approvals per group are required for the request to be approved. The number will be the same across all groups. Known values: number, percent, numberPerPrincipal
$ (anyOf 1).conditionType (anyOf 2)	null	Alternative
$ (anyOf 1).conditionValue	JSON	Optional
$ (anyOf 1).conditionValue (anyOf 1)	string	Alternative	The number or percentage of approvals required for a request to be approved. If `conditionType` is `number`, the value must be 20 or less. If `conditionType` is `percent`, the value must be 100 or less.
$ (anyOf 1).conditionValue (anyOf 2)	null	Alternative
$ (anyOf 1).exclude	JSON	Optional
$ (anyOf 1).exclude (anyOf 1)	JSON	Alternative
$ (anyOf 1).exclude (anyOf 1) (anyOf 1)	array	Alternative	A list of roles that should be excluded as possible approvers.
$ (anyOf 1).exclude (anyOf 1) (anyOf 1)[]	JSON	Each item
$ (anyOf 1).exclude (anyOf 1) (anyOf 1)[] (anyOf 1)	string	Alternative	A list of roles that should be excluded as possible approvers. Known values: assignee, reporter
$ (anyOf 1).exclude (anyOf 1) (anyOf 1)[] (anyOf 2)	null	Alternative
$ (anyOf 1).exclude (anyOf 1) (anyOf 2)	null	Alternative
$ (anyOf 1).exclude (anyOf 2)	null	Alternative
$ (anyOf 1).fieldId	JSON	Optional
$ (anyOf 1).fieldId (anyOf 1)	string	Alternative	The custom field ID of the "Approvers" or "Approver Groups" field.
$ (anyOf 1).fieldId (anyOf 2)	null	Alternative
$ (anyOf 1).prePopulatedFieldId	JSON	Optional
$ (anyOf 1).prePopulatedFieldId (anyOf 1)	JSON	Alternative
$ (anyOf 1).prePopulatedFieldId (anyOf 1) (anyOf 1)	string	Alternative	The custom field ID of the field used to pre-populate the Approver field. Only supports the "Affected Services" field.
$ (anyOf 1).prePopulatedFieldId (anyOf 1) (anyOf 2)	null	Alternative
$ (anyOf 1).prePopulatedFieldId (anyOf 2)	null	Alternative
$ (anyOf 1).transitionApproved	JSON	Optional
$ (anyOf 1).transitionApproved (anyOf 1)	string	Alternative	The numeric ID of the transition to be executed if the request is approved.
$ (anyOf 1).transitionApproved (anyOf 2)	null	Alternative
$ (anyOf 1).transitionRejected	JSON	Optional
$ (anyOf 1).transitionRejected (anyOf 1)	string	Alternative	The numeric ID of the transition to be executed if the request is declined.
$ (anyOf 1).transitionRejected (anyOf 2)	null	Alternative
$ (anyOf 2)	null	Alternative

Read workflow version from history — response body — workflows array item statuses array item layout value

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	The x and y location of the status in the workflow.
$ (anyOf 1).x	JSON	Optional
$ (anyOf 1).x (anyOf 1)	JSON	Alternative
$ (anyOf 1).x (anyOf 1) (anyOf 1)	JSON	Alternative
$ (anyOf 1).x (anyOf 1) (anyOf 1) (anyOf 1)	number	Alternative	The x axis location. Format: double
$ (anyOf 1).x (anyOf 1) (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).x (anyOf 1) (anyOf 2)	null	Alternative
$ (anyOf 1).x (anyOf 2)	null	Alternative
$ (anyOf 1).y	JSON	Optional
$ (anyOf 1).y (anyOf 1)	JSON	Alternative
$ (anyOf 1).y (anyOf 1) (anyOf 1)	JSON	Alternative
$ (anyOf 1).y (anyOf 1) (anyOf 1) (anyOf 1)	number	Alternative	The y axis location. Format: double
$ (anyOf 1).y (anyOf 1) (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).y (anyOf 1) (anyOf 2)	null	Alternative
$ (anyOf 1).y (anyOf 2)	null	Alternative
$ (anyOf 2)	null	Alternative

Read workflow version from history — response body — workflows array item transitions array item

Field	Type	Presence	Description and constraints
$	object	Root	The transitions of the workflow.
actions	JSON	Optional
actions (anyOf 1)	array	Alternative	The post-functions of the transition.
actions (anyOf 1)[]	Model	Each item	Expand Read workflow version from history — response body — workflows array item transitions array item transition Screen value
actions (anyOf 2)	null	Alternative
conditions	JSON	Optional
conditions (anyOf 1)	Model	Alternative	Expand Read workflow version from history — response body — workflows array item transitions array item conditions value
conditions (anyOf 2)	null	Alternative
customIssueEventId	JSON	Optional
customIssueEventId (anyOf 1)	JSON	Alternative
customIssueEventId (anyOf 1) (anyOf 1)	string	Alternative	The custom event ID of the transition.
customIssueEventId (anyOf 1) (anyOf 2)	null	Alternative
customIssueEventId (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative	The description of the transition.
description (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the transition.
id (anyOf 2)	null	Alternative
links	JSON	Optional
links (anyOf 1)	array	Alternative	The statuses the transition can start from, and the mapping of ports between the statuses.
links (anyOf 1)[]	Model	Each item	Expand Read workflow version from history — response body — workflows array item transitions array item links array item
links (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the transition.
name (anyOf 2)	null	Alternative
properties	JSON	Optional
properties (anyOf 1)	object	Alternative	The properties of the transition. Additional keys: see wildcard field
properties (anyOf 1).*	string	Additional keys	The properties of the transition.
properties (anyOf 2)	null	Alternative
toStatusReference	JSON	Optional
toStatusReference (anyOf 1)	string	Alternative	The status the transition goes to.
toStatusReference (anyOf 2)	null	Alternative
transitionScreen	JSON	Optional
transitionScreen (anyOf 1)	Model	Alternative	Expand Read workflow version from history — response body — workflows array item transitions array item transition Screen value
transitionScreen (anyOf 2)	null	Alternative
triggers	JSON	Optional
triggers (anyOf 1)	array	Alternative	The triggers of the transition.
triggers (anyOf 1)[]	Model	Each item	Expand Read workflow version from history — response body — workflows array item transitions array item triggers The triggers of the transition item
triggers (anyOf 2)	null	Alternative
type	JSON	Optional
type (anyOf 1)	string	Alternative	The transition type. Known values: INITIAL, GLOBAL, DIRECTED
type (anyOf 2)	null	Alternative
validators	JSON	Optional
validators (anyOf 1)	array	Alternative	The validators of the transition.
validators (anyOf 1)[]	Model	Each item	Expand Read workflow version from history — response body — workflows array item transitions array item transition Screen value
validators (anyOf 2)	null	Alternative

Referenced models: Read workflow version from history — response body — workflows array item transitions array item conditions value, Read workflow version from history — response body — workflows array item transitions array item transition Screen value, Read workflow version from history — response body — workflows array item transitions array item links array item, Read workflow version from history — response body — workflows array item transitions array item triggers The triggers of the transition item

Read workflow version from history — response body — workflows array item transitions array item conditions value

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	The conditions group associated with the transition.
$ (anyOf 1).conditionGroups	JSON	Optional
$ (anyOf 1).conditionGroups (anyOf 1)	array	Alternative	The nested conditions of the condition group.
$ (anyOf 1).conditionGroups (anyOf 1)[]	Model	Each item	Expand Read workflow version from history — response body — workflows array item transitions array item conditions value
$ (anyOf 1).conditionGroups (anyOf 2)	null	Alternative
$ (anyOf 1).conditions	JSON	Optional
$ (anyOf 1).conditions (anyOf 1)	array	Alternative	The rules for this condition.
$ (anyOf 1).conditions (anyOf 1)[]	Model	Each item	Expand Read workflow version from history — response body — workflows array item transitions array item transition Screen value
$ (anyOf 1).conditions (anyOf 2)	null	Alternative
$ (anyOf 1).operation	JSON	Optional
$ (anyOf 1).operation (anyOf 1)	string	Alternative	Determines how the conditions in the group are evaluated. Accepts either `ANY` or `ALL`. If `ANY` is used, at least one condition in the group must be true for the group to evaluate to true. If `ALL` is used, all conditions in the group must be true for the group to evaluate to true. Known values: ANY, ALL
$ (anyOf 1).operation (anyOf 2)	null	Alternative
$ (anyOf 2)	null	Alternative

Referenced models: Read workflow version from history — response body — workflows array item transitions array item conditions value, Read workflow version from history — response body — workflows array item transitions array item transition Screen value

Read workflow version from history — response body — workflows array item transitions array item links array item

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	The statuses the transition can start from, and the mapping of ports between the statuses.
$ (anyOf 1).fromPort	JSON	Optional
$ (anyOf 1).fromPort (anyOf 1)	JSON	Alternative
$ (anyOf 1).fromPort (anyOf 1) (anyOf 1)	JSON	Alternative
$ (anyOf 1).fromPort (anyOf 1) (anyOf 1) (anyOf 1)	integer	Alternative	The port that the transition starts from. Format: int32
$ (anyOf 1).fromPort (anyOf 1) (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).fromPort (anyOf 1) (anyOf 2)	null	Alternative
$ (anyOf 1).fromPort (anyOf 2)	null	Alternative
$ (anyOf 1).fromStatusReference	JSON	Optional
$ (anyOf 1).fromStatusReference (anyOf 1)	JSON	Alternative
$ (anyOf 1).fromStatusReference (anyOf 1) (anyOf 1)	string	Alternative	The status that the transition starts from.
$ (anyOf 1).fromStatusReference (anyOf 1) (anyOf 2)	null	Alternative
$ (anyOf 1).fromStatusReference (anyOf 2)	null	Alternative
$ (anyOf 1).toPort	JSON	Optional
$ (anyOf 1).toPort (anyOf 1)	JSON	Alternative
$ (anyOf 1).toPort (anyOf 1) (anyOf 1)	JSON	Alternative
$ (anyOf 1).toPort (anyOf 1) (anyOf 1) (anyOf 1)	integer	Alternative	The port that the transition goes to. Format: int32
$ (anyOf 1).toPort (anyOf 1) (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).toPort (anyOf 1) (anyOf 2)	null	Alternative
$ (anyOf 1).toPort (anyOf 2)	null	Alternative
$ (anyOf 2)	null	Alternative

Read workflow version from history — response body — workflows array item transitions array item transition Screen value

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	The configuration of the rule.
$ (anyOf 1).id	JSON	Optional
$ (anyOf 1).id (anyOf 1)	JSON	Alternative
$ (anyOf 1).id (anyOf 1) (anyOf 1)	string	Alternative	The ID of the rule.
$ (anyOf 1).id (anyOf 1) (anyOf 2)	null	Alternative
$ (anyOf 1).id (anyOf 2)	null	Alternative
$ (anyOf 1).parameters	JSON	Optional
$ (anyOf 1).parameters (anyOf 1)	object	Alternative	The parameters related to the rule. Additional keys: see wildcard field
$ (anyOf 1).parameters (anyOf 1).*	string	Additional keys	The parameters related to the rule.
$ (anyOf 1).parameters (anyOf 2)	null	Alternative
$ (anyOf 1).ruleKey	JSON	Optional
$ (anyOf 1).ruleKey (anyOf 1)	string	Alternative	The rule key of the rule.
$ (anyOf 1).ruleKey (anyOf 2)	null	Alternative
$ (anyOf 2)	null	Alternative

Read workflow version from history — response body — workflows array item transitions array item triggers The triggers of the transition item

Field	Type	Presence	Description and constraints
$	object	Root	The trigger configuration associated with a workflow.
id	JSON	Optional
id (anyOf 1)	string	Alternative	The ID of the trigger.
id (anyOf 2)	null	Alternative
parameters	JSON	Optional
parameters (anyOf 1)	object	Alternative	The parameters of the trigger. Additional keys: see wildcard field
parameters (anyOf 1).*	string	Additional keys	The parameters of the trigger.
parameters (anyOf 2)	null	Alternative
ruleKey	JSON	Optional
ruleKey (anyOf 1)	string	Alternative	The rule key of the trigger.
ruleKey (anyOf 2)	null	Alternative

Search workflows — response body

Field	Type	Presence	Description and constraints
$	object	Root	Page of items, including workflows and related statuses.
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	If there is another page of results, the URL of the next page.
nextPage (anyOf 2)	null	Alternative
self	JSON	Optional
self (anyOf 1)	string	Alternative	The URL of the 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. Format: int64
startAt (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startAt (anyOf 2)	null	Alternative
statuses	JSON	Optional
statuses (anyOf 1)	array	Alternative	List of statuses.
statuses (anyOf 1)[]	Model	Each item	Expand Search workflows — response body — statuses List of statuses item
statuses (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
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	List of workflows.
values (anyOf 1)[]	Model	Each item	Expand Search workflows — response body — values List of workflows item
values (anyOf 2)	null	Alternative

Referenced models: Search workflows — response body — values List of workflows item, Search workflows — response body — statuses List of statuses item

Search workflows — response body — statuses List of statuses 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 workflow schemes — response body — item scope The scope of the workflow
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
statusReference	JSON	Optional
statusReference (anyOf 1)	string	Alternative	The reference of the status.
statusReference (anyOf 2)	null	Alternative

Referenced models: Bulk get workflow schemes — response body — item scope The scope of the workflow