Jira Workflows API is one of 132 APIs that Jira publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Workflows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an API reference.
This API exposes
16 operations
across 16 paths,
and defines 93 schemas.
It is described by OpenAPI 3.2.0, at version 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df.
Requests are made against a single base URL, https://your-domain.atlassian.net.
The identity and technical contract details declared by the specification.
WorkflowPreviewRequest
object
The details of the preview workflow request.
4 properties
1 required
ProjectUsage
object
The project.
1 property
TransitionScreenDetails
object
The details of a transition screen.
2 properties
1 required
TransitionPreview
object
Details about a workflow transition in preview context.
12 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
AvailableWorkflowSystemRule
object
The Atlassian provided system rules available.
7 properties
7 required
ApprovalConfiguration
objectnull
The approval configuration of a status within a workflow. Applies only to Jira Service Management approvals.
8 properties
6 required
WorkflowRules
object
A collection of transition rules.
3 properties
ConditionGroupConfiguration
objectnull
The conditions group associated with the transition.
3 properties
AvailableWorkflowTriggers
object
The trigger rules available.
2 properties
2 required
WorkflowUpdateValidateRequestBean
object
2 properties
1 required
WorkflowRuleConfiguration
objectnull
The configuration of the rule.
3 properties
1 required
WorkflowDocumentStatusDTO
object
The statuses stored for the specified version.
6 properties
WorkflowPreview
object
Details of a workflow.
10 properties
WorkflowSchemeUsage
object
The worflow scheme.
1 property
AvailableWorkflowConnectRule
object
The Connect provided ecosystem rules available.
9 properties
DocumentVersion
object
The current version details of this workflow scheme.
2 properties
ApprovalConfigurationPreview
object
Approval configuration.
3 properties
WorkflowHistoryReadRequest
object
A request to read a specific workflow version from history.
2 properties
WorkflowLayout
objectnull
The starting point for the statuses in the workflow.
2 properties
WorkflowUpdate
object
The details of the workflows to update.
9 properties
4 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
AvatarUrlsBean
object
4 properties
WorkflowStatus
object
Details of a workflow status.
3 properties
2 required
WorkflowUpdateResponse
object
3 properties
WorkflowPreviewResponse
object
The preview workflow response containing workflows and statuses.
2 properties
WorkflowSchemeUsagePage
object
A page of workflow schemes.
2 properties
ProjectDetails
object
Details about a project.
8 properties
WorkflowTransitionLinks
objectnull
The statuses the transition can start from, and the mapping of ports between the statuses.
3 properties
WorkflowTransitionRule
object
A workflow transition rule.
2 properties
1 required
PreviewConditionGroupConfiguration
objectnull
Condition group configuration for workflow transitions.
3 properties
StatusMigration
object
The mapping of old to new status ID.
2 properties
2 required
JiraWorkflowStatus
object
Details of a status.
6 properties
WorkflowCapabilities
object
6 properties
WorkflowCreateRequest
object
The create workflows payload.
3 properties
StatusLayoutUpdate
object
The statuses associated with this workflow.
4 properties
2 required
WorkflowDocumentDTO
object
The workflow stored for the specified version.
12 properties
WorkflowOperations
object
Operations allowed on a workflow
2 properties
2 required
PreviewTrigger
object
Trigger configuration for workflow transitions.
2 properties
TransitionUpdateDTO
object
The transition update data.
13 properties
ProjectAndIssueTypePair
object
A project and issueType ID pair that identifies a status mapping.
2 properties
2 required
ProjectUsagePage
object
A page of projects.
2 properties
Workflow
object
Details about a workflow.
11 properties
2 required
WorkflowTrigger
object
The trigger configuration associated with a workflow.
3 properties
2 required
JiraWorkflow
object
Details of a workflow.
13 properties
ProjectIssueTypeQueryContext
object
Project and issue type context for workflow queries made using issue types.
2 properties
WorkflowHistoryReadResponseDTO
object
The specified workflow version read from history.
2 properties
WorkflowPreviewStatus
object
Details about a workflow status in preview context.
4 properties
PublishedWorkflowId
object
Properties that identify a published workflow.
2 properties
1 required
WorkflowSchemeIdName
object
The ID and the name of the workflow scheme.
2 properties
2 required
WorkflowProjectIssueTypeUsage
object
The issue type.
1 property
WorkflowCreate
object
The details of the workflows to create.
6 properties
3 required
ConditionGroupUpdate
objectnull
The conditions group associated with the transition.
3 properties
1 required
WorkflowStatusLayout
objectnull
The x and y location of the status in the workflow.
2 properties
WorkflowReadResponse
object
Details of workflows and related statuses.
2 properties
WorkflowPreviewScope
object
The scope of the workflow.
2 properties
DefaultWorkflowEditorResponse
object
1 property
AvailableWorkflowTriggerTypes
object
The list of available trigger types.
3 properties
StatusMappingDTO
object
The mapping of old to new status ID for a specific project and issue type.
3 properties
3 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
WorkflowProjectIssueTypeUsagePage
object
A page of issue types.
2 properties
WorkflowHistoryListRequest
object
A request to read all the workflow history entries for a specific workflow.
1 property
WorkflowReferenceStatus
object
The statuses referenced in the workflow.
5 properties
WorkflowUpdateRequest
object
The update workflows payload.
2 properties
WorkflowValidationErrorList
object
1 property
WorkflowProjectIssueTypeUsageDTO
object
Issue types associated with the workflow for a project.
3 properties
WorkflowCreateValidateRequest
object
2 properties
1 required
AvailableWorkflowForgeRule
object
The Forge provided ecosystem rules available.
5 properties
JiraWorkflowPreviewStatus
object
Details of a status.
7 properties
WorkflowProjectUsageDTO
object
Projects using the workflow.
2 properties
ErrorCollection
object
Error messages from an operation.
3 properties
WorkflowReadRequest
object
3 properties
TransitionLink
object
Link information for workflow transitions.
3 properties
WorkflowProjectIdScope
objectnull
Project ID details.
1 property
PageBeanWorkflow
object
A page of items.
7 properties
WorkflowSchemeUsageDTO
object
Workflow schemes using the workflow.
2 properties
WorkflowSimpleCondition
object
A workflow transition rule condition. This object returns nodeType as simple.
3 properties
2 required
WorkflowHistoryItemDTO
object
A single entry in the WorkflowHistoryPage.
4 properties
PreviewRuleConfiguration
objectnull
Rule configuration for workflow transitions.
3 properties
WorkflowValidationError
object
The details about a workflow validation error.
6 properties
WorkflowStatusUpdate
object
Details of the status being updated.
5 properties
3 required
WorkflowCreateResponse
object
Details of the created workflows and statuses.
2 properties
WorkflowPreviewLayout
object
Layout coordinates for workflow elements.
2 properties
ProjectId
objectnull
Project ID details.
1 property
1 required
WorkflowDocumentVersionBean
object
The version details of the workflow.
2 properties
WorkflowTransitions
object
The transitions of the workflow.
13 properties
WorkflowScope
object
The scope of the workflow.
2 properties
Transition
object
Details of a workflow transition.
9 properties
6 required
WorkflowCompoundCondition
object
A compound workflow transition rule condition. This object returns nodeType as compound.
3 properties
3 required
WorkflowCondition
object
The workflow transition rule conditions tree.
WorkflowSearchResponse
object
Page of items, including workflows and related statuses.
8 properties
WorkflowHistoryListResponseDTO
object
A list of workflow history entries.
1 property
UpdatedProjectCategory
object
A project category.
4 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Jira publishes across the network.
