• Announcement banner
  • App data policies (EAP)
  • Application roles
  • Audit records
  • Avatars
  • Classification levels
  • Dashboards
  • Filters
  • Filter sharing
  • Group and user picker
  • Groups
  • Issues
  • UI modifications (apps)
  • Issue attachments
  • Issue comments
  • Issue comment properties
  • Issue fields
  • Issue field configurations
  • Issue custom field contexts
  • Issue custom field options
  • Issue custom field options (apps)
  • Issue custom field values (apps)
  • Issue custom field configuration (apps)
  • Issue navigator settings
  • Issue notification schemes
  • Issue priorities
  • Issue properties
  • Issue resolutions
  • Issue security level
  • Issue security schemes
  • Issue types
  • Issue type schemes
  • Issue type screen schemes
  • Issue type properties
  • Issue votes
  • Issue watchers
  • Issue worklogs
  • Issue worklog properties
  • Jira expressions
  • Jira settings
  • JQL
  • JQL functions (apps)
  • Labels
  • License metrics
  • Myself
  • Permissions
  • Permission schemes
  • Projects
  • Project avatars
  • Project categories
  • Project classification levels
  • Project components
  • Project email
  • Project features
  • Project key and name validation
  • Project permission schemes
  • Project properties
  • Project roles
  • Project role actors
  • Project types
  • Project versions
  • Screens
  • Screen tabs
  • Screen tab fields
  • Screen schemes
  • Server info
  • Status
  • Tasks
  • Time tracking
  • Users
  • User properties
  • Webhooks
  • Workflows
  • Workflow transition rules
  • Workflow schemes
  • Workflow scheme project associations
  • Workflow scheme drafts
  • Workflow statuses
  • Workflow status categories
  • Workflow transition properties
  • App properties
  • Dynamic modules
  • App migration
  • Service Registry
Cloud
Jira Cloud platform / Reference / REST API v3 (beta)

Workflow schemes

Postman Collection
OpenAPI

This resource represents workflow schemes. Use it to manage workflow schemes and the workflow scheme's workflows and issue types.

A workflow scheme maps issue types to workflows. A workflow scheme can be associated with one or more projects, which enables the projects to use the workflow-issue type mappings.

Active workflow schemes (workflow schemes that are used by projects) cannot be edited. When an active workflow scheme is edited, a draft copy of the scheme is created. The draft workflow scheme is then be edited and published (replacing the active scheme).

See Configuring workflow schemes for more information.

GET

Get all workflow schemes

Returns a paginated list of all workflow schemes, not including draft workflow schemes.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:read:workflow-scheme:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type:jira ...(Show more)

Request

Query parameters

startAt

integer

maxResults

integer

Responses

Returned if the request is successful.

application/json

PageBeanWorkflowScheme

A page of items.

GET/rest/api/3/workflowscheme
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestJira(route`/rest/api/3/workflowscheme`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 { "isLast": true, "maxResults": 50, "startAt": 0, "total": 2, "values": [ { "defaultWorkflow": "jira", "description": "The description of the example workflow scheme.", "id": 101010, "issueTypeMappings": { "10000": "scrum workflow", "10001": "builds workflow" }, "name": "Example workflow scheme", "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010" }, { "defaultWorkflow": "jira", "description": "The description of the another example workflow scheme.", "id": 101011, "issueTypeMappings": { "10000": "scrum workflow", "10001": "builds workflow" }, "name": "Another example workflow scheme", "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101011" } ] }
POST

Create workflow scheme

Creates a workflow scheme.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:write:workflow-scheme:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type:jira ...(Show more)

Request

Request bodyapplication/json

defaultWorkflow

string

description

string

issueTypeMappings

object

name

string

updateDraftIfNeeded

boolean

Responses

Returned if the request is successful.

application/json

WorkflowScheme

Details about a workflow scheme.

POST/rest/api/3/workflowscheme
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "defaultWorkflow": "jira", "description": "The description of the example workflow scheme.", "issueTypeMappings": { "10000": "scrum workflow", "10001": "builds workflow" }, "name": "Example workflow scheme" }`; const response = await api.asUser().requestJira(route`/rest/api/3/workflowscheme`, { method: 'POST', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
201Response
1 2 3 4 5 6 7 8 9 10 11 12 { "defaultWorkflow": "jira", "description": "The description of the example workflow scheme.", "draft": false, "id": 101010, "issueTypeMappings": { "10000": "scrum workflow", "10001": "builds workflow" }, "name": "Example workflow scheme", "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010" }
POST

Bulk get workflow schemesExperimental

Returns a list of workflow schemes by providing workflow scheme IDs or project IDs.

Permissions required:

  • Administer Jira global permission to access all, including project-scoped, workflow schemes
  • Administer projects project permissions to access project-scoped workflow schemes
Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:read:workflow-scheme:jira

Request

Query parameters

expand

string

Request bodyapplication/json

projectIds

array<string>

workflowSchemeIds

array<string>

Responses

Returned if the request is successful.

application/json

array<WorkflowSchemeReadResponse>

POST/rest/api/3/workflowscheme/read
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "projectIds": [ "10047", "10048" ], "workflowSchemeIds": [ "3e59db0f-ed6c-47ce-8d50-80c0c4572677" ] }`; const response = await api.asUser().requestJira(route`/rest/api/3/workflowscheme/read`, { method: 'POST', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 [ { "defaultWorkflow": { "description": "This is the default workflow for Software Development projects.", "id": "3e59db0f-ed6c-47ce-8d50-80c0c4572677", "name": "Default Software Development Workflow", "usage": [ { "issueTypeIds": [], "projectId": "10047" } ], "version": { "id": "657812fc-bc72-400f-aae0-df8d88db3d9g", "versionNumber": 1 } }, "description": "This is the workflow scheme for the Software Development project type.", "id": "3g78dg2a-ns2n-56ab-9812-42h5j1464567", "name": "Software Developer Workflow Scheme", "projectIdsUsingScheme": [ "10047" ], "scope": { "project": { "id": "10047" }, "type": "GLOBAL" }, "taskId": "3f83dg2a-ns2n-56ab-9812-42h5j1461629", "version": { "id": "527213fc-bc72-400f-aae0-df8d88db2c8a", "versionNumber": 1 }, "workflowsForIssueTypes": [ { "issueTypeIds": [ "10013" ], "workflow": { "description": "This is the workflow for the Software Development bug issue type.", "id": "5e79ae0f-ed6c-47ce-8d50-80c0c4572745", "name": "Software Development Bug Workflow", "usage": [ { "issueTypeIds": [ "10013" ], "projectId": "10047" } ], "version": { "id": "897812dc-bc72-400f-aae0-df8d88fe3d8f", "versionNumber": 1 } } } ] } ]
POST

Update workflow schemeExperimental

Updates company-managed and team-managed project workflow schemes. This API doesn't have a concept of draft, so any changes made to a workflow scheme are immediately available. When changing the available statuses for issue types, an asynchronous task migrates the issues as defined in the provided mappings.

Permissions required:

  • Administer Jira project permission to update all, including global-scoped, workflow schemes.
  • Administer projects project permission to update project-scoped workflow schemes.
Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:write:workflow-scheme:jira

Request

Request bodyapplication/json

defaultWorkflowId

string

description

string

Required
id

string

Required
name

string

Required
statusMappingsByIssueTypeOverride

array<MappingsByIssueTypeOverride>

statusMappingsByWorkflows

array<MappingsByWorkflow>

version

DocumentVersion

Required
workflowsForIssueTypes

array<WorkflowSchemeAssociation>

Additional Properties

any

Responses

Returned if the request is successful and there is no asynchronous task.

application/json

any

POST/rest/api/3/workflowscheme/update
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "defaultWorkflowId": "3e59db0f-ed6c-47ce-8d50-80c0c4572677", "description": "description", "id": "10000", "name": "name", "statusMappingsByIssueTypeOverride": [ { "issueTypeId": "10001", "statusMappings": [ { "newStatusId": "2", "oldStatusId": "1" }, { "newStatusId": "4", "oldStatusId": "3" } ] }, { "issueTypeId": "10002", "statusMappings": [ { "newStatusId": "4", "oldStatusId": "1" }, { "newStatusId": "2", "oldStatusId": "3" } ] } ], "statusMappingsByWorkflows": [ { "newWorkflowId": "3e59db0f-ed6c-47ce-8d50-80c0c4572677", "oldWorkflowId": "3e59db0f-ed6c-47ce-8d50-80c0c4572677", "statusMappings": [ { "newStatusId": "2", "oldStatusId": "1" }, { "newStatusId": "4", "oldStatusId": "3" } ] } ], "version": { "id": "527213fc-bc72-400f-aae0-df8d88db2c8a", "versionNumber": 1 }, "workflowsForIssueTypes": [ { "issueTypeIds": [ "10000", "10003" ], "workflowId": "3e59db0f-ed6c-47ce-8d50-80c0c4572677" }, { "issueTypeIds": [ "10001`", "10002" ], "workflowId": "3f83dg2a-ns2n-56ab-9812-42h5j1461629" } ] }`; const response = await api.asUser().requestJira(route`/rest/api/3/workflowscheme/update`, { method: 'POST', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
POST

Get required status mappings for workflow scheme updateExperimental

Gets the required status mappings for the desired changes to a workflow scheme. The results are provided per issue type and workflow. When updating a workflow scheme, status mappings can be provided per issue type, per workflow, or both.

Permissions required:

  • Administer Jira permission to update all, including global-scoped, workflow schemes.
  • Administer projects project permission to update project-scoped workflow schemes.
Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:write:workflow-scheme:jira

Request

Request bodyapplication/json

defaultWorkflowId

string

id

string

Required
workflowsForIssueTypes

array<WorkflowSchemeAssociation>

Required

Responses

Returned if the request is successful.

application/json

WorkflowSchemeUpdateRequiredMappingsResponse
POST/rest/api/3/workflowscheme/update/mappings
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "defaultWorkflowId": "10010", "id": "10001", "workflowsForIssueTypes": [ { "issueTypeIds": [ "10010", "10011" ], "workflowId": "10001" } ] }`; const response = await api.asUser().requestJira(route`/rest/api/3/workflowscheme/update/mappings`, { method: 'POST', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 { "statusMappingsByIssueTypes": [ { "issueTypeId": "10000", "statusIds": [ "10000", "10001" ] } ], "statusMappingsByWorkflows": [ { "sourceWorkflowId": "10000", "statusIds": [ "10000", "10001" ], "targetWorkflowId": "10001" } ], "statuses": [ { "category": "TODO", "id": "10000", "name": "To Do" } ], "statusesPerWorkflow": [ { "initialStatusId": "10000", "statuses": [ "10000", "10001" ], "workflowId": "10000" } ] }
GET

Get workflow scheme

Returns a workflow scheme.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:read:workflow-scheme:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type:jira ...(Show more)

Request

Path parameters

id

integer

Required

Query parameters

returnDraftIfExists

boolean

Responses

Returned if the request is successful.

application/json

WorkflowScheme

Details about a workflow scheme.

GET/rest/api/3/workflowscheme/{id}
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestJira(route`/rest/api/3/workflowscheme/{id}`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 { "defaultWorkflow": "jira", "description": "The description of the example workflow scheme.", "draft": false, "id": 101010, "issueTypeMappings": { "10000": "scrum workflow", "10001": "builds workflow" }, "name": "Example workflow scheme", "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010" }
PUT

Classic update workflow scheme

Updates a company-manged project workflow scheme, including the name, default workflow, issue type to project mappings, and more. If the workflow scheme is active (that is, being used by at least one project), then a draft workflow scheme is created or updated instead, provided that updateDraftIfNeeded is set to true.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:read:workflow-scheme:jira, write:workflow-scheme:jira, read:application-role:jira, read:avatar:jira, read:group:jira ...(Show more)

Request

Path parameters

id

integer

Required

Request bodyapplication/json

defaultWorkflow

string

description

string

issueTypeMappings

object

name

string

updateDraftIfNeeded

boolean

Responses

Returned if the request is successful.

application/json

WorkflowScheme

Details about a workflow scheme.

PUT/rest/api/3/workflowscheme/{id}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "defaultWorkflow": "jira", "description": "The description of the example workflow scheme.", "issueTypeMappings": { "10000": "scrum workflow" }, "name": "Example workflow scheme", "updateDraftIfNeeded": false }`; const response = await api.asUser().requestJira(route`/rest/api/3/workflowscheme/{id}`, { method: 'PUT', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 { "defaultWorkflow": "jira", "description": "The description of the example workflow scheme.", "draft": false, "id": 101010, "issueTypeMappings": { "10000": "scrum workflow", "10001": "builds workflow" }, "name": "Example workflow scheme", "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010" }
DEL

Delete workflow scheme

Deletes a workflow scheme. Note that a workflow scheme cannot be deleted if it is active (that is, being used by at least one project).

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:delete:workflow-scheme:jira

Request

Path parameters

id

integer

Required

Responses

Returned if the request is successful.

application/json

any

DEL/rest/api/3/workflowscheme/{id}
1 2 3 4 5 6 7 8 9 10 11 12 13 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestJira(route`/rest/api/3/workflowscheme/{id}`, { method: 'DELETE', headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
GET

Get default workflow

Returns the default workflow for a workflow scheme. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has All Unassigned Issue Types listed in its issue types for the workflow scheme in Jira.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:read:workflow-scheme:jira, read:workflow:jira

Request

Path parameters

id

integer

Required

Query parameters

returnDraftIfExists

boolean

Responses

Returned if the request is successful.

application/json

DefaultWorkflow

Details about the default workflow.

GET/rest/api/3/workflowscheme/{id}/default
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestJira(route`/rest/api/3/workflowscheme/{id}/default`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 { "workflow": "jira" }
PUT

Update default workflow

Sets the default workflow for a workflow scheme.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request object and a draft workflow scheme is created or updated with the new default workflow. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:read:workflow-scheme:jira, write:workflow-scheme:jira, read:application-role:jira, read:avatar:jira, read:group:jira ...(Show more)

Request

Path parameters

id

integer

Required

Request bodyapplication/json

The new default workflow.

updateDraftIfNeeded

boolean

workflow

string

Required

Responses

Returned if the request is successful.

application/json

WorkflowScheme

Details about a workflow scheme.

PUT/rest/api/3/workflowscheme/{id}/default
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "updateDraftIfNeeded": false, "workflow": "jira" }`; const response = await api.asUser().requestJira(route`/rest/api/3/workflowscheme/{id}/default`, { method: 'PUT', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 { "defaultWorkflow": "jira", "description": "The description of the example workflow scheme.", "draft": false, "id": 101010, "issueTypeMappings": { "10000": "scrum workflow", "10001": "builds workflow" }, "name": "Example workflow scheme", "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010" }
DEL

Delete default workflow

Resets the default workflow for a workflow scheme. That is, the default workflow is set to Jira's system workflow (the jira workflow).

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the default workflow reset. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:read:workflow-scheme:jira, write:workflow-scheme:jira, read:application-role:jira, read:avatar:jira, read:group:jira ...(Show more)

Request

Path parameters

id

integer

Required

Query parameters

updateDraftIfNeeded

boolean

Responses

Returned if the request is successful.

application/json

WorkflowScheme

Details about a workflow scheme.

DEL/rest/api/3/workflowscheme/{id}/default
1 2 3 4 5 6 7 8 9 10 11 12 13 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestJira(route`/rest/api/3/workflowscheme/{id}/default`, { method: 'DELETE', headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 { "defaultWorkflow": "jira", "description": "The description of the example workflow scheme.", "draft": false, "id": 101010, "issueTypeMappings": { "10000": "scrum workflow", "10001": "builds workflow" }, "name": "Example workflow scheme", "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010" }
GET

Get workflow for issue type in workflow scheme

Returns the issue type-workflow mapping for an issue type in a workflow scheme.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:read:workflow-scheme:jira, read:workflow:jira, read:issue-type:jira

Request

Path parameters

id

integer

Required
issueType

string

Required

Query parameters

returnDraftIfExists

boolean

Responses

Returned if the request is successful.

application/json

IssueTypeWorkflowMapping

Details about the mapping between an issue type and a workflow.

GET/rest/api/3/workflowscheme/{id}/issuetype/{issueType}
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestJira(route`/rest/api/3/workflowscheme/{id}/issuetype/{issueType}`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 { "issueType": "10000", "workflow": "jira" }
PUT

Set workflow for issue type in workflow scheme

Sets the workflow for an issue type in a workflow scheme.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request body and a draft workflow scheme is created or updated with the new issue type-workflow mapping. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:write:workflow-scheme:jira, read:workflow-scheme:jira, read:workflow:jira, read:application-role:jira, read:avatar:jira ...(Show more)

Request

Path parameters

id

integer

Required
issueType

string

Required

Request bodyapplication/json

The issue type-project mapping.

issueType

string

updateDraftIfNeeded

boolean

workflow

string

Responses

Returned if the request is successful.

application/json

WorkflowScheme

Details about a workflow scheme.

PUT/rest/api/3/workflowscheme/{id}/issuetype/{issueType}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "issueType": "10000", "updateDraftIfNeeded": false, "workflow": "jira" }`; const response = await api.asUser().requestJira(route`/rest/api/3/workflowscheme/{id}/issuetype/{issueType}`, { method: 'PUT', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 { "defaultWorkflow": "jira", "description": "The description of the example workflow scheme.", "draft": false, "id": 101010, "issueTypeMappings": { "10000": "scrum workflow", "10001": "builds workflow" }, "name": "Example workflow scheme", "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010" }
DEL

Delete workflow for issue type in workflow scheme

Deletes the issue type-workflow mapping for an issue type in a workflow scheme.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the issue type-workflow mapping deleted. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:delete:workflow-scheme:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type:jira ...(Show more)

Request

Path parameters

id

integer

Required
issueType

string

Required

Query parameters

updateDraftIfNeeded

boolean

Responses

Returned if the request is successful.

application/json

WorkflowScheme

Details about a workflow scheme.

DEL/rest/api/3/workflowscheme/{id}/issuetype/{issueType}
1 2 3 4 5 6 7 8 9 10 11 12 13 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestJira(route`/rest/api/3/workflowscheme/{id}/issuetype/{issueType}`, { method: 'DELETE', headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 { "defaultWorkflow": "jira", "description": "The description of the example workflow scheme.", "draft": false, "id": 101010, "issueTypeMappings": { "10000": "scrum workflow", "10001": "builds workflow" }, "name": "Example workflow scheme", "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010" }
GET

Get issue types for workflows in workflow scheme

Returns the workflow-issue type mappings for a workflow scheme.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:read:workflow-scheme:jira, read:workflow:jira, read:issue-type:jira

Request

Path parameters

id

integer

Required

Query parameters

workflowName

string

returnDraftIfExists

boolean

Responses

Returned if the request is successful.

application/json

IssueTypesWorkflowMapping

Details about the mapping between issue types and a workflow.

GET/rest/api/3/workflowscheme/{id}/workflow
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestJira(route`/rest/api/3/workflowscheme/{id}/workflow`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 { "defaultMapping": false, "issueTypes": [ "10000", "10001" ], "workflow": "jira" }
PUT

Set issue types for workflow in workflow scheme

Sets the issue types for a workflow in a workflow scheme. The workflow can also be set as the default workflow for the workflow scheme. Unmapped issues types are mapped to the default workflow.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request body and a draft workflow scheme is created or updated with the new workflow-issue types mappings. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:write:workflow-scheme:jira, read:workflow-scheme:jira, read:workflow:jira, read:application-role:jira, read:avatar:jira ...(Show more)

Request

Path parameters

id

integer

Required

Query parameters

workflowName

string

Required

Request bodyapplication/json

defaultMapping

boolean

issueTypes

array<string>

updateDraftIfNeeded

boolean

workflow

string

Responses

Returned if the request is successful.

application/json

WorkflowScheme

Details about a workflow scheme.

PUT/rest/api/3/workflowscheme/{id}/workflow
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; var bodyData = `{ "issueTypes": [ "10000" ], "updateDraftIfNeeded": true, "workflow": "jira" }`; const response = await api.asUser().requestJira(route`/rest/api/3/workflowscheme/{id}/workflow?workflowName={workflowName}`, { method: 'PUT', headers: { 'Accept': 'application/json', 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 { "defaultWorkflow": "jira", "description": "The description of the example workflow scheme.", "draft": false, "id": 101010, "issueTypeMappings": { "10000": "scrum workflow", "10001": "builds workflow" }, "name": "Example workflow scheme", "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010" }
DEL

Delete issue types for workflow in workflow scheme

Deletes the workflow-issue type mapping for a workflow in a workflow scheme.

Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the workflow-issue type mapping deleted. The draft workflow scheme can be published in Jira.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredADMIN

ClassicRECOMMENDED:manage:jira-configuration
Granular:delete:workflow-scheme:jira

Request

Path parameters

id

integer

Required

Query parameters

workflowName

string

Required
updateDraftIfNeeded

boolean

Responses

Returned if the request is successful.

DEL/rest/api/3/workflowscheme/{id}/workflow
1 2 3 4 5 6 7 8 9 10 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestJira(route`/rest/api/3/workflowscheme/{id}/workflow?workflowName={workflowName}`, { method: 'DELETE' }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());

Rate this page: