Atlassian Workflows API is one of 183 APIs that Atlassian publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 17 JSON Schema definitions.
Tagged areas include Workflows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 17 JSON Schemas.
This API exposes
10 operations
across 9 paths,
and defines 70 schemas.
It is described by OpenAPI 3.2.0, at version 1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77.
Requests are made against a single base URL, https://your-domain.atlassian.net.
The identity and technical contract details declared by the specification.
WorkflowCompoundCondition
object
A compound workflow transition rule condition. This object returns nodeType as compound.
3 properties
3 required
WorkflowIDs
object
The classic workflow identifiers.
2 properties
1 required
WorkflowReferenceStatus
object
The statuses referenced in the workflow.
4 properties
Scope
object
The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).
2 properties
WorkflowTransitionRule
object
A workflow transition rule.
2 properties
1 required
WorkflowStatus
object
Details of a workflow status.
3 properties
2 required
WorkflowStatusAndPort
objectnull
The status reference and port that a transition is connected to.
2 properties
WorkflowCondition
object
The workflow transition rule conditions tree.
WorkflowReadRequest
object
3 properties
Transition
object
Details of a workflow transition.
9 properties
6 required
StatusMigration
object
The mapping of old to new status ID.
2 properties
2 required
DocumentVersion
object
The current version details of this workflow scheme.
2 properties
2 required
UpdatedProjectCategory
object
A project category.
4 properties
WorkflowSchemeIdName
object
The ID and the name of the workflow scheme.
2 properties
2 required
WorkflowSimpleCondition
object
A workflow transition rule condition. This object returns nodeType as simple.
3 properties
2 required
DeprecatedWorkflow
object
Details about a workflow.
8 properties
WorkflowCreate
object
The details of the workflows to create.
5 properties
3 required
PublishedWorkflowId
object
Properties that identify a published workflow.
2 properties
1 required
CreateWorkflowTransitionRulesDetails
object
The details of a workflow transition rules.
3 properties
WorkflowCreateValidateRequest
object
2 properties
1 required
WorkflowCreateResponse
object
Details of the created workflows and statuses.
2 properties
CreateWorkflowTransitionRule
object
A workflow transition rule.
2 properties
1 required
ValidationOptionsForCreate
object
The level of validation to return from the API. If no values are provided, the default would return WARNING and ERROR level validation results.
1 property
ErrorCollection
object
Error messages from an operation.
3 properties
StatusLayoutUpdate
object
The statuses associated with this workflow.
3 properties
2 required
AvailableWorkflowTriggers
object
The trigger rules available.
2 properties
2 required
WorkflowStatusLayout
objectnull
The x and y location of the status in the workflow.
2 properties
ValidationOptionsForUpdate
object
The level of validation to return from the API. If no values are provided, the default would return WARNING and ERROR level validation results.
1 property
CreateWorkflowCondition
object
A workflow transition condition.
4 properties
WorkflowValidationErrorList
object
1 property
StatusReferenceAndPort
objectnull
The status reference and port that a transition is connected to.
2 properties
1 required
WorkflowCapabilities
object
6 properties
WorkflowUpdateValidateRequestBean
object
2 properties
1 required
WorkflowCreateRequest
object
The create workflows payload.
3 properties
3 required
Workflow
object
Details about a workflow.
11 properties
2 required
StatusMappingDTO
object
The mapping of old to new status ID for a specific project and issue type.
3 properties
3 required
AvailableWorkflowConnectRule
object
The Connect provided ecosystem rules available.
9 properties
CreateWorkflowTransitionScreenDetails
object
The details of a transition screen.
1 property
1 required
ProjectIssueTypes
object
Use the optional workflows.usages expand to get additional information about the projects and issue types associated with the requested workflows.
2 properties
JiraWorkflowStatus
object
Details of a status.
7 properties
CreateWorkflowStatusDetails
object
The details of a transition status.
2 properties
1 required
TransitionScreenDetails
object
The details of a transition screen.
2 properties
1 required
ProjectAndIssueTypePair
object
A project and issueType ID pair that identifies a status mapping.
2 properties
2 required
WorkflowElementReference
object
A reference to the location of the error. This will be null if the error does not refer to a specific element.
5 properties
WorkflowOperations
object
Operations allowed on a workflow
2 properties
2 required
ConditionGroupUpdate
objectnull
The conditions group associated with the transition.
3 properties
1 required
CreateWorkflowTransitionDetails
object
The details of a workflow transition.
8 properties
3 required
WorkflowRuleConfiguration
objectnull
The configuration of the rule.
3 properties
1 required
ProjectDetails
object
Details about a project.
8 properties
AvailableWorkflowForgeRule
object
The Forge provided ecosystem rules available.
5 properties
WorkflowTransitions
object
The transitions of the workflow.
13 properties
WorkflowUpdateRequest
object
The update workflows payload.
2 properties
2 required
WorkflowTrigger
object
The trigger configuration associated with a workflow.
3 properties
2 required
AvatarUrlsBean
object
4 properties
TransitionUpdateDTO
object
The transitions of this workflow.
13 properties
3 required
WorkflowStatusUpdate
object
Details of the status being updated.
5 properties
3 required
WorkflowValidationError
object
The details about a workflow validation error.
5 properties
AvailableWorkflowTriggerTypes
object
The list of available trigger types.
3 properties
CreateWorkflowDetails
object
The details of a workflow.
4 properties
3 required
WorkflowUpdateResponse
object
3 properties
WorkflowUpdate
object
The details of the workflows to update.
8 properties
4 required
PageBeanWorkflow
object
A page of items.
7 properties
WorkflowLayout
objectnull
The starting point for the statuses in the workflow.
2 properties
WorkflowReadResponse
object
Details of workflows and related statuses.
2 properties
AvailableWorkflowSystemRule
object
The Atlassian provided system rules available.
7 properties
7 required
WorkflowRules
object
A collection of transition rules.
3 properties
JiraWorkflow
object
Details of a workflow.
11 properties
ConditionGroupConfiguration
objectnull
The conditions group associated with the transition.
3 properties
ProjectId
objectnull
Project ID details.
1 property
1 required
WorkflowScope
object
The scope of the workflow.
2 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Atlassian publishes across the network.
