Atlassian Workflow Schemes API

The Workflow Schemes API from Atlassian — 8 operation(s) for workflow schemes.

Documentation GitHub OpenAPI

Operations 17

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /rest/api/3/workflowscheme List all workflow schemes · Atlassian Get All Workflow Schemes #

Ask an LLM

“What workflow schemes exist in my Jira site?”

“Does the workflow scheme list include drafts?”

Tell an agent

List every workflow scheme in Jira.

Page through workflow schemes starting at {startAt}, {maxResults} at a time.

POST /rest/api/3/workflowscheme Create a workflow scheme · Atlassian Create Workflow Scheme #

Ask an LLM

“How do I create a new workflow scheme for my company-managed projects?”

“Can I set a default workflow and issue type mappings when creating a scheme?”

Tell an agent

Create a workflow scheme named {name} with default workflow {defaultWorkflow}.

Make a new workflow scheme {name} described as {description}.

POST /rest/api/3/workflowscheme/read Look up workflow schemes by scheme or project IDs · Atlassian Bulk Get Workflow Schemes #

Ask an LLM

“Which workflow scheme is a given set of projects using?”

“Can I fetch several workflow schemes at once by their IDs?”

Tell an agent

Get the workflow schemes used by projects {projectIds}.

Fetch workflow schemes {workflowSchemeIds} in one bulk read.

POST /rest/api/3/workflowscheme/update Update a workflow scheme immediately, without drafts · Atlassian Update Workflow Scheme #

Ask an LLM

“Is there a way to change a team-managed project's workflow scheme with no draft step?”

“What happens to issue statuses when I change a scheme's workflows for issue types?”

Tell an agent

Update workflow scheme {id} at version {version} with name {name} and description {description}, applying immediately.

Set default workflow {defaultWorkflowId} on scheme {id} (version {version}, name {name}, description {description}) right away.

POST /rest/api/3/workflowscheme/update/mappings Preview status mappings needed for a scheme change · Atlassian Get Required Status Mappings For Workflow Scheme Update #

Ask an LLM

“Which status mappings will I need to provide before changing a workflow scheme?”

“Can I see the required status migrations per issue type for a planned scheme update?”

Tell an agent

Work out the status mappings required to apply {workflowsForIssueTypes} to workflow scheme {id}.

Preview the status mappings for scheme {id} if its default workflow becomes {defaultWorkflowId} with {workflowsForIssueTypes}.

DELETE /rest/api/3/workflowscheme/{id} Delete an unused workflow scheme · Atlassian Delete Workflow Scheme #

Ask an LLM

“Can I delete a workflow scheme that a project is still using?”

“How do I clean up old workflow schemes nobody uses?”

Tell an agent destructive · confirm first

Delete workflow scheme {id}.

Remove the inactive workflow scheme {id} from Jira.

GET /rest/api/3/workflowscheme/{id} Get a workflow scheme · Atlassian Get Workflow Scheme #

Ask an LLM

“What workflows and issue types are configured in one workflow scheme?”

“Can I see the draft version of a workflow scheme instead of the live one?”

Tell an agent

Get workflow scheme {id}.

Show workflow scheme {id}, returning the draft if one exists: {returnDraftIfExists}.

PUT /rest/api/3/workflowscheme/{id} Edit a company-managed workflow scheme (draft if active) · Atlassian Classic Update Workflow Scheme #

Ask an LLM

“How do I rename a workflow scheme that projects are already using?”

“Does editing an active workflow scheme create a draft instead of changing it live?”

Tell an agent

Rename workflow scheme {id} to {name}, creating a draft if it's active ({updateDraftIfNeeded}).

Update the issue type mappings of workflow scheme {id} to {issueTypeMappings}.

DELETE /rest/api/3/workflowscheme/{id}/default Reset a scheme's default workflow to the system one · Atlassian Delete Default Workflow #

Ask an LLM

“How do I revert a workflow scheme's default back to Jira's built-in workflow?”

“What does resetting the default workflow on a scheme do?”

Tell an agent destructive · confirm first

Reset the default workflow of scheme {id} to the jira system workflow.

Clear the custom default workflow on scheme {id}, using a draft if active: {updateDraftIfNeeded}.

GET /rest/api/3/workflowscheme/{id}/default Get a workflow scheme's default workflow · Atlassian Get Default Workflow #

Ask an LLM

“Which workflow do unmapped issue types fall back to in my scheme?”

“What is the default workflow on a scheme's draft?”

Tell an agent

Get the default workflow of workflow scheme {id}.

Show the fallback workflow for unassigned issue types in scheme {id}.

PUT /rest/api/3/workflowscheme/{id}/default Set a workflow scheme's default workflow · Atlassian Update Default Workflow #

Ask an LLM

“How do I change which workflow unmapped issue types use in a scheme?”

“Can I set the default workflow on an active scheme through a draft?”

Tell an agent

Set {workflow} as the default workflow of scheme {id}.

Make {workflow} the default for scheme {id}, updating a draft if needed: {updateDraftIfNeeded}.

DELETE /rest/api/3/workflowscheme/{id}/issuetype/{issueType} Remove an issue type's workflow mapping from a scheme · Atlassian Delete Workflow For Issue Type In Workflow Scheme #

Ask an LLM

“How do I send an issue type back to the scheme's default workflow?”

“Can I unmap one issue type from its workflow in a scheme?”

Tell an agent destructive · confirm first

Remove the workflow mapping for issue type {issueType} in scheme {id}.

Unmap issue type {issueType} from scheme {id}, using a draft if active: {updateDraftIfNeeded}.

GET /rest/api/3/workflowscheme/{id}/issuetype/{issueType} Get the workflow mapped to an issue type in a scheme · Atlassian Get Workflow For Issue Type In Workflow Scheme #

Ask an LLM

“Which workflow do bugs use under a particular workflow scheme?”

“Is a given issue type mapped to its own workflow in my scheme?”

Tell an agent

Get the workflow mapped to issue type {issueType} in scheme {id}.

Show which workflow issue type {issueType} follows in workflow scheme {id}.

PUT /rest/api/3/workflowscheme/{id}/issuetype/{issueType} Assign a workflow to an issue type in a scheme · Atlassian Set Workflow For Issue Type In Workflow Scheme #

Ask an LLM

“How do I make stories use a different workflow from bugs in one scheme?”

“Can I map a single issue type to a workflow on an active scheme?”

Tell an agent

Map issue type {issueType} to workflow {workflow} in scheme {id}.

Use workflow {workflow} for issue type {issueType} on scheme {id}, updating a draft if needed: {updateDraftIfNeeded}.

DELETE /rest/api/3/workflowscheme/{id}/workflow Remove a workflow's issue type mappings from a scheme · Atlassian Delete Issue Types For Workflow In Workflow Scheme #

Ask an LLM

“How do I take a workflow out of a workflow scheme entirely?”

“What happens to issue types when I delete a workflow's mapping in a scheme?”

Tell an agent destructive · confirm first

Delete the mapping for workflow {workflowName} from scheme {id}.

Remove workflow {workflowName} from scheme {id}, creating a draft if active: {updateDraftIfNeeded}.

GET /rest/api/3/workflowscheme/{id}/workflow List a scheme's workflow-to-issue-type mappings · Atlassian Get Issue Types For Workflows In Workflow Scheme #

Ask an LLM

“Which issue types is each workflow in my scheme assigned to?”

“Can I see the issue types mapped to one named workflow in a scheme?”

Tell an agent

List the workflow-issue type mappings for scheme {id}.

Show which issue types use workflow {workflowName} in scheme {id}.

PUT /rest/api/3/workflowscheme/{id}/workflow Set the issue types for a workflow in a scheme · Atlassian Set Issue Types For Workflow In Workflow Scheme #

Ask an LLM

“How do I assign several issue types to one workflow at once in a scheme?”

“Can I also make that workflow the scheme default while mapping issue types?”

Tell an agent

Assign issue types {issueTypes} to workflow {workflowName} in scheme {id}.

Map workflow {workflowName} in scheme {id} as the default mapping: {defaultMapping}.

Atlassian Workflow Schemes API

Operations 17

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification