Developer
Get Support
Sign in
Developer
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Get support
Sign in
Developer
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Get support
Sign in
  • Approval
  • Customer
  • Customer Request
  • Customer Transition
  • Jira Service Management Application
  • Organization
  • Organization Service Desk
  • Portals
  • Queue
  • Queue Settings
  • Request Attachment
  • Request Type
  • Request Type Permissions
  • Service Desk
  • Service Desk Customer
  • application-properties
  • applicationrole
  • attachment
  • avatar
  • cluster
  • comment
  • component
  • configuration
  • customFieldOption
  • customFields
  • dashboard
  • email-templates
  • field
  • filter
  • group
  • groups
  • groupuserpicker
  • index
  • index-snapshot
  • issue
  • issueLink
  • issueLinkType
  • issuesecurityschemes
  • issuetype
  • issuetypescheme
  • jql
  • licenseValidator
  • monitoring
  • mypermissions
  • mypreferences
  • myself
  • notificationscheme
  • password
  • permissions
  • permissionscheme
  • priority
  • priorityschemes
  • project
  • projectCategory
  • projects
  • projectvalidate
  • reindex
  • resolution
  • role
  • screens
  • search
  • searchLimits
  • securitylevel
  • serverInfo
  • session
  • settings
  • status
  • statuscategory
  • terminology
  • universal_avatar
  • upgrade
  • user
  • version
  • websudo
  • workflow
  • workflowscheme
  • worklog
  • Assets - AQL
  • Assets - Analytics
  • Assets - Archived Objects
  • Assets - Attachments
  • Assets - Comments
  • Assets - Icons
  • Assets - Index Configuration
  • Assets - Object
  • Assets - Object Archive
  • Assets - Object Attribute
  • Assets - Object Connected Tickets
  • Assets - Object Restore
  • Assets - Object Schema
  • Assets - Object Type
  • Assets - Object Type Attribute
  • Assets - Progress
  • Assets - QR Code
  • Assets - Status Types
Server
Jira Service Management / Reference / REST API

workflowscheme

Postman Collection
OpenAPI
Operations
POST/api/2/workflowschemeGET/api/2/workflowscheme/{id}PUT/api/2/workflowscheme/{id}DEL/api/2/workflowscheme/{id}POST/api/2/workflowscheme/{id}/createdraftGET/api/2/workflowscheme/{id}/defaultPUT/api/2/workflowscheme/{id}/defaultDEL/api/2/workflowscheme/{id}/defaultGET/api/2/workflowscheme/{id}/draftPUT/api/2/workflowscheme/{id}/draftDEL/api/2/workflowscheme/{id}/draftGET/api/2/workflowscheme/{id}/draft/defaultPUT/api/2/workflowscheme/{id}/draft/defaultDEL/api/2/workflowscheme/{id}/draft/defaultGET/api/2/workflowscheme/{id}/draft/issuetype/{issueType}PUT/api/2/workflowscheme/{id}/draft/issuetype/{issueType}DEL/api/2/workflowscheme/{id}/draft/issuetype/{issueType}GET/api/2/workflowscheme/{id}/draft/workflowPUT/api/2/workflowscheme/{id}/draft/workflowDEL/api/2/workflowscheme/{id}/draft/workflowGET/api/2/workflowscheme/{id}/issuetype/{issueType}PUT/api/2/workflowscheme/{id}/issuetype/{issueType}DEL/api/2/workflowscheme/{id}/issuetype/{issueType}GET/api/2/workflowscheme/{id}/workflowPUT/api/2/workflowscheme/{id}/workflowDEL/api/2/workflowscheme/{id}/workflow
POST

Create a new workflow scheme

Create a new workflow scheme. The body contains a representation of the new scheme. Values not passed are assumed to be set to their defaults.

Forge and OAuth2 apps cannot access this REST resource.

Request

Request bodyapplication/json

The body contains a representation of the new scheme. Values not passed are assumed to be set to their defaults.

defaultWorkflow

string

description

string

draft

boolean

id

integer

issueTypeMappings

object

issueTypes

object

lastModified

string

lastModifiedUser

UserBean

name

string

originalDefaultWorkflow

string

Responses

The newly created scheme.

POST/api/2/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 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 curl --request POST \ --url 'http://{baseurl}/rest/api/2/workflowscheme' \ --header 'Content-Type: application/json' \ --data '{ "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }'
GET

Get requested workflow scheme by ID

Returns the requested workflow scheme to the caller.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

integer

Required

Query parameters

returnDraftIfExists

boolean

Responses

Returned if the scheme exists and the caller has permission to see it.

application/json

WorkflowSchemeBean
GET/api/2/workflowscheme/{id}
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}' \ --header 'Accept: application/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 { "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }
PUT

Update a specified workflow scheme

Update the passed workflow scheme. The body of the request is a representation of the workflow scheme. Values not passed are assumed to indicate no change for that field. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created and/or updated when the actual scheme cannot be edited (e.g. when the scheme is being used by a project). Values not appearing the body will not be touched.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

integer

Required

Request bodyapplication/json

The body of the request is a representation of the workflow scheme. Values not passed are assumed to indicate no change for that field.

defaultWorkflow

string

description

string

draft

boolean

id

integer

issueTypeMappings

object

issueTypes

object

lastModified

string

lastModifiedUser

UserBean

name

string

originalDefaultWorkflow

string

Responses

The updated scheme.

application/json

WorkflowSchemeBean
PUT/api/2/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 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 curl --request PUT \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }'
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 { "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }
DEL

Delete the specified workflow scheme

Delete the passed workflow scheme.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

integer

Required

Responses

If the scheme was deleted.

DEL/api/2/workflowscheme/{id}
1 2 curl --request DELETE \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}'
POST

Create a draft for a workflow scheme

Create a draft for the passed scheme. The draft will be a copy of the state of the parent.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

integer

Required

Responses

The newly created scheme.

application/json

WorkflowSchemeBean
POST/api/2/workflowscheme/{id}/createdraft
1 2 3 curl --request POST \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/createdraft' \ --header 'Accept: application/json'
201Response
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 { "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }
GET

Get default workflow for a scheme

Return the default workflow from the passed workflow scheme.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

integer

Required

Query parameters

returnDraftIfExists

boolean

Responses

Returned on success.

application/json

WorkflowSchemeBean
GET/api/2/workflowscheme/{id}/default
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/default' \ --header 'Accept: application/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 { "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }
PUT

Update default workflow for a scheme

Set the default workflow for the passed workflow scheme. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created/updated when the actual scheme cannot be edited.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

integer

Required

Request bodyapplication/json

The new default.

updateDraftIfNeeded

boolean

workflow

string

Responses

Returned on success.

application/json

WorkflowSchemeBean
PUT/api/2/workflowscheme/{id}/default
1 2 3 4 5 6 7 8 curl --request PUT \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/default' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "updateDraftIfNeeded": true, "workflow": "<string>" }'
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 { "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }
DEL

Remove default workflow from a scheme

Remove the default workflow from the passed workflow scheme.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

integer

Required

Query parameters

updateDraftIfNeeded

boolean

Responses

Returned on success.

application/json

WorkflowSchemeBean
DEL/api/2/workflowscheme/{id}/default
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/default' \ --header 'Accept: application/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 { "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }
GET

Get requested draft workflow scheme by ID

Returns the requested draft workflow scheme to the caller.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

integer

Required

Responses

Returned if the scheme exists and the caller has permission to see it.

application/json

WorkflowSchemeBean
GET/api/2/workflowscheme/{id}/draft
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft' \ --header 'Accept: application/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 { "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }
PUT

Update a draft workflow scheme

Update a draft workflow scheme. The draft will created if necessary. The body of the request is a representation of the workflow scheme. Values not passed are assumed to indicate no change for that field.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

integer

Required

Request bodyapplication/json

The body of the request is a representation of the workflow scheme. Values not passed are assumed to indicate no change for that field.

defaultWorkflow

string

description

string

draft

boolean

id

integer

issueTypeMappings

object

issueTypes

object

lastModified

string

lastModifiedUser

UserBean

name

string

originalDefaultWorkflow

string

Responses

The updated/created scheme.

application/json

WorkflowSchemeBean
PUT/api/2/workflowscheme/{id}/draft
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 curl --request PUT \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }'
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 { "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }
DEL

Delete the specified draft workflow scheme

Delete the passed draft workflow scheme.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

integer

Required

Responses

If the scheme was deleted.

DEL/api/2/workflowscheme/{id}/draft
1 2 curl --request DELETE \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft'
GET

Get default workflow for a draft scheme

Return the default workflow from the passed draft workflow scheme to the caller.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

integer

Required

Responses

Returned on success.

application/json

WorkflowSchemeBean
GET/api/2/workflowscheme/{id}/draft/default
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft/default' \ --header 'Accept: application/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 { "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }
PUT

Update default workflow for a draft scheme

Set the default workflow for the passed draft workflow scheme.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

integer

Required

Request bodyapplication/json

The new default.

updateDraftIfNeeded

boolean

workflow

string

Responses

Returned on success.

application/json

WorkflowSchemeBean
PUT/api/2/workflowscheme/{id}/draft/default
1 2 3 4 5 6 7 8 curl --request PUT \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft/default' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "updateDraftIfNeeded": true, "workflow": "<string>" }'
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 { "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }
DEL

Remove default workflow from a draft scheme

Remove the default workflow from the passed draft workflow scheme.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

integer

Required

Responses

Returned on success.

application/json

WorkflowSchemeBean
DEL/api/2/workflowscheme/{id}/draft/default
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft/default' \ --header 'Accept: application/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 { "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }
GET

Get issue type mapping for a draft scheme

Returns the issue type mapping for the passed draft workflow scheme.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

issueType

string

Required
id

integer

Required

Responses

Returned on success.

application/json

IssueTypeMappingBean
GET/api/2/workflowscheme/{id}/draft/issuetype/{issueType}
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft/issuetype/{issueType}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 { "issueType": "10000", "updateDraftIfNeeded": false, "workflow": "My Workflow" }
PUT

Set an issue type mapping for a draft scheme

Set the issue type mapping for the passed draft scheme. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created/updated when the actual scheme cannot be edited.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

issueType

string

Required
id

integer

Required

Request bodyapplication/json

The new mapping for the issue type.

issueType

string

updateDraftIfNeeded

boolean

workflow

string

Responses

Returned on success.

application/json

WorkflowSchemeBean
PUT/api/2/workflowscheme/{id}/draft/issuetype/{issueType}
1 2 3 4 5 6 7 8 9 curl --request PUT \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft/issuetype/{issueType}' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "issueType": "10000", "updateDraftIfNeeded": false, "workflow": "My Workflow" }'
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 { "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }
DEL

Delete an issue type mapping from a draft scheme

Remove the specified issue type mapping from the draft scheme.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

issueType

string

Required
id

integer

Required

Responses

Returned on success.

application/json

WorkflowSchemeBean
DEL/api/2/workflowscheme/{id}/draft/issuetype/{issueType}
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft/issuetype/{issueType}' \ --header 'Accept: application/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 { "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }
GET

Get draft workflow mappings

Returns the draft workflow mappings or requested mapping to the caller.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

integer

Required

Query parameters

workflowName

string

Responses

Returned on success.

application/json

WorkflowSchemeBean
GET/api/2/workflowscheme/{id}/draft/workflow
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft/workflow' \ --header 'Accept: application/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 { "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }
PUT

Update a workflow mapping in a draft scheme

Update the draft scheme to include the passed mapping. The body is a representation of the workflow mapping. Values not passed are assumed to indicate no change for that field.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

integer

Required

Query parameters

workflowName

string

Request bodyapplication/json

The body is a representation of the workflow mapping. Values not passed are assumed to indicate no change for that field.

defaultMapping

boolean

issueTypes

array<string>

updateDraftIfNeeded

boolean

workflow

string

Responses

The updated scheme.

application/json

WorkflowSchemeBean
PUT/api/2/workflowscheme/{id}/draft/workflow
1 2 3 4 5 6 7 8 9 10 11 12 curl --request PUT \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft/workflow' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "defaultMapping": true, "issueTypes": [ "<string>" ], "updateDraftIfNeeded": true, "workflow": "<string>" }'
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 { "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }
DEL

Delete a workflow mapping from a draft scheme

Delete the passed workflow from the draft workflow scheme.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

integer

Required

Query parameters

workflowName

string

Responses

The scheme with the workflow deleted.

application/json

WorkflowSchemeBean
DEL/api/2/workflowscheme/{id}/draft/workflow
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/draft/workflow' \ --header 'Accept: application/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 { "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }
GET

Get issue type mapping for a scheme

Returns the issue type mapping for the passed workflow scheme.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

issueType

string

Required
id

integer

Required

Query parameters

returnDraftIfExists

boolean

Responses

Returned on success.

application/json

IssueTypeMappingBean
GET/api/2/workflowscheme/{id}/issuetype/{issueType}
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/issuetype/{issueType}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 { "issueType": "10000", "updateDraftIfNeeded": false, "workflow": "My Workflow" }
PUT

Set an issue type mapping for a scheme

Set the issue type mapping for the passed scheme. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created/updated when the actual scheme cannot be edited.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

issueType

string

Required
id

integer

Required

Request bodyapplication/json

The new mapping for the issue type.

issueType

string

updateDraftIfNeeded

boolean

workflow

string

Responses

Returned on success.

application/json

WorkflowSchemeBean
PUT/api/2/workflowscheme/{id}/issuetype/{issueType}
1 2 3 4 5 6 7 8 9 curl --request PUT \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/issuetype/{issueType}' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "issueType": "10000", "updateDraftIfNeeded": false, "workflow": "My Workflow" }'
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 { "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }
DEL

Delete an issue type mapping from a scheme

Remove the specified issue type mapping from the scheme.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

issueType

string

Required
id

integer

Required

Query parameters

updateDraftIfNeeded

boolean

Responses

Returned on success.

application/json

WorkflowSchemeBean
DEL/api/2/workflowscheme/{id}/issuetype/{issueType}
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/issuetype/{issueType}' \ --header 'Accept: application/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 { "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }
GET

Get workflow mappings for a scheme

Returns the workflow mappings or requested mapping to the caller for the passed scheme.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

integer

Required

Query parameters

workflowName

string

returnDraftIfExists

boolean

Responses

Returned on success.

application/json

WorkflowSchemeBean
GET/api/2/workflowscheme/{id}/workflow
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/workflow' \ --header 'Accept: application/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 { "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }
PUT

Update a workflow mapping in a scheme

Update the scheme to include the passed mapping. The body is a representation of the workflow mapping. Values not passed are assumed to indicate no change for that field. The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the draft should be created/updated when the actual scheme cannot be edited.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

integer

Required

Query parameters

workflowName

string

Request bodyapplication/json

The body is a representation of the workflow mapping. Values not passed are assumed to indicate no change for that field.

defaultMapping

boolean

issueTypes

array<string>

updateDraftIfNeeded

boolean

workflow

string

Responses

The updated scheme.

application/json

WorkflowSchemeBean
PUT/api/2/workflowscheme/{id}/workflow
1 2 3 4 5 6 7 8 9 10 11 12 curl --request PUT \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/workflow' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "defaultMapping": true, "issueTypes": [ "<string>" ], "updateDraftIfNeeded": true, "workflow": "<string>" }'
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 { "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }
DEL

Delete a workflow mapping from a scheme

Delete the passed workflow from the workflow scheme.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

integer

Required

Query parameters

updateDraftIfNeeded

boolean

workflowName

string

Responses

The scheme with the workflow deleted.

application/json

WorkflowSchemeBean
DEL/api/2/workflowscheme/{id}/workflow
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/rest/api/2/workflowscheme/{id}/workflow' \ --header 'Accept: application/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 { "defaultWorkflow": "DefaultWorkflowName", "description": "This is a workflow scheme", "draft": false, "id": 10000, "issueTypeMappings": { "IsueTypeId": "WorkflowName", "IsueTypeId2": "WorkflowName" }, "issueTypes": { "IsueTypeId": { "name": "IssueTypeName", "description": "IssueTypeDescription" } }, "lastModified": "Today 12:45", "lastModifiedUser": { "active": true, "applicationRoles": [ "jira-core", "jira-admin", "important" ], "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "deleted": false, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "expand": "<string>", "groups": { "callback": {}, "maxResults": 2154, "pagingCallback": {}, "size": 2154 }, "key": "JIRAUSER10100", "lastLoginTime": "2023-08-30T16:37:01+1000", "locale": "en_AU", "name": "fred", "self": "http://www.example.com/jira/rest/api/2.0/user?username=fred", "timeZone": "Australia/Sydney" }, "name": "My Workflow Scheme", "originalDefaultWorkflow": "ParentsDefaultWorkflowName", "originalIssueTypeMappings": { "IssueTypeId": "WorkflowName2" }, "self": "http://www.example.com/jira/rest/api/2/workflowscheme/10000", "updateDraftIfNeeded": true }

Rate this page: