This resource represents draft workflow schemes. Use it to manage drafts of workflow schemes.
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. Editing an active workflow scheme creates a draft copy of the scheme. The draft workflow scheme can then be edited and published (replacing the active scheme).
See Configuring workflow schemes for more information.
Create a draft workflow scheme from an active workflow scheme, by copying the active workflow scheme. Note that an active workflow scheme can only have one draft workflow scheme.
Permissions required: Administer Jira global permission.
manage:jira-configurationread:group:jira, read:issue-security-level:jira, read:project-role:jira, read:screen:jira, read:status:jira ...(Show more)Connect app scope required: ADMIN
integer
RequiredReturned if the request is successful.
Details about a workflow scheme.
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}/createdraft`, {
method: 'POST',
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());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
{
"defaultWorkflow": "scrum workflow",
"description": "The description of the example workflow scheme.",
"draft": true,
"id": 17218781,
"issueTypeMappings": {
"10000": "jira",
"10001": "jira"
},
"lastModified": "Today 6:38 PM",
"lastModifiedUser": {
"accountId": "5b10a2844c20165700ede21g",
"accountType": "atlassian",
"active": true,
"applicationRoles": {
"items": [],
"size": 1
},
"avatarUrls": {
"16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
"24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
"32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
"48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
},
"displayName": "Mia Krystof",
"emailAddress": "mia@example.com",
"groups": {
"items": [],
"size": 3
},
"key": "",
"name": "",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
"timeZone": "Australia/Sydney"
},
"name": "Example workflow scheme",
"originalDefaultWorkflow": "jira",
"originalIssueTypeMappings": {
"10001": "builds workflow"
},
"self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"
}Returns the draft workflow scheme for an active workflow scheme. Draft workflow schemes allow changes to be made to the active workflow schemes: When an active workflow scheme is updated, a draft copy is created. The draft is modified, then the changes in the draft are copied back to the active workflow scheme. See Configuring workflow schemes for more information.
Note that:
Permissions required: Administer Jira global permission.
manage:jira-configurationread:group:jira, read:issue-security-level:jira, read:project-role:jira, read:screen:jira, read:status:jira ...(Show more)Connect app scope required: ADMIN
integer
RequiredReturned if the request is successful.
Details about a workflow scheme.
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}/draft`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());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
{
"defaultWorkflow": "scrum workflow",
"description": "The description of the example workflow scheme.",
"draft": true,
"id": 17218781,
"issueTypeMappings": {
"10000": "jira",
"10001": "jira"
},
"lastModified": "Today 6:38 PM",
"lastModifiedUser": {
"accountId": "5b10a2844c20165700ede21g",
"accountType": "atlassian",
"active": true,
"applicationRoles": {
"items": [],
"size": 1
},
"avatarUrls": {
"16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
"24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
"32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
"48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
},
"displayName": "Mia Krystof",
"emailAddress": "mia@example.com",
"groups": {
"items": [],
"size": 3
},
"key": "",
"name": "",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
"timeZone": "Australia/Sydney"
},
"name": "Example workflow scheme",
"originalDefaultWorkflow": "jira",
"originalIssueTypeMappings": {
"10001": "builds workflow"
},
"self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"
}Updates a draft workflow scheme. If a draft workflow scheme does not exist for the active workflow scheme, then a draft is created. Note that an active workflow scheme can only have one draft workflow scheme.
Permissions required: Administer Jira global permission.
manage:jira-configurationread:group:jira, read:issue-security-level:jira, read:project-role:jira, read:screen:jira, read:status:jira ...(Show more)Connect app scope required: ADMIN
integer
Requiredstring
string
object
string
boolean
Returned if the request is successful.
Details about a workflow scheme.
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}/draft`, {
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());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
{
"defaultWorkflow": "scrum workflow",
"description": "The description of the example workflow scheme.",
"draft": true,
"id": 17218781,
"issueTypeMappings": {
"10000": "jira",
"10001": "jira"
},
"lastModified": "Today 6:38 PM",
"lastModifiedUser": {
"accountId": "5b10a2844c20165700ede21g",
"accountType": "atlassian",
"active": true,
"applicationRoles": {
"items": [],
"size": 1
},
"avatarUrls": {
"16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
"24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
"32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
"48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
},
"displayName": "Mia Krystof",
"emailAddress": "mia@example.com",
"groups": {
"items": [],
"size": 3
},
"key": "",
"name": "",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
"timeZone": "Australia/Sydney"
},
"name": "Example workflow scheme",
"originalDefaultWorkflow": "jira",
"originalIssueTypeMappings": {
"10001": "builds workflow"
},
"self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"
}Deletes a draft workflow scheme.
Permissions required: Administer Jira global permission.
manage:jira-configurationdelete:workflow-scheme:jiraConnect app scope required: ADMIN
integer
RequiredReturned if the request is successful.
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}/draft`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Returns the default workflow for a workflow scheme's draft. 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.
manage:jira-configurationread:workflow-scheme:jira, read:workflow:jiraConnect app scope required: ADMIN
integer
RequiredReturned if the request is successful.
Details about the default 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}/draft/default`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
{
"workflow": "jira"
}Sets the default workflow for a workflow scheme's draft.
Permissions required: Administer Jira global permission.
manage:jira-configurationwrite:workflow-scheme:jira, read:workflow-scheme:jira, read:workflow:jira, read:application-role:jira, read:avatar:jira ...(Show more)Connect app scope required: ADMIN
integer
RequiredThe object for the new default workflow.
boolean
string
RequiredReturned if the request is successful.
Details about a workflow scheme.
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}/draft/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());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
{
"defaultWorkflow": "scrum workflow",
"description": "The description of the example workflow scheme.",
"draft": true,
"id": 17218781,
"issueTypeMappings": {
"10000": "jira",
"10001": "jira"
},
"lastModified": "Today 6:38 PM",
"lastModifiedUser": {
"accountId": "5b10a2844c20165700ede21g",
"accountType": "atlassian",
"active": true,
"applicationRoles": {
"items": [],
"size": 1
},
"avatarUrls": {
"16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
"24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
"32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
"48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
},
"displayName": "Mia Krystof",
"emailAddress": "mia@example.com",
"groups": {
"items": [],
"size": 3
},
"key": "",
"name": "",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
"timeZone": "Australia/Sydney"
},
"name": "Example workflow scheme",
"originalDefaultWorkflow": "jira",
"originalIssueTypeMappings": {
"10001": "builds workflow"
},
"self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"
}Resets the default workflow for a workflow scheme's draft. That is, the default workflow is set to Jira's system workflow (the jira workflow).
Permissions required: Administer Jira global permission.
manage:jira-configurationdelete:workflow-scheme:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type:jira ...(Show more)Connect app scope required: ADMIN
integer
RequiredReturned if the request is successful.
Details about a workflow scheme.
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}/draft/default`, {
method: 'DELETE',
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());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
{
"defaultWorkflow": "scrum workflow",
"description": "The description of the example workflow scheme.",
"draft": true,
"id": 17218781,
"issueTypeMappings": {
"10000": "jira",
"10001": "jira"
},
"lastModified": "Today 6:38 PM",
"lastModifiedUser": {
"accountId": "5b10a2844c20165700ede21g",
"accountType": "atlassian",
"active": true,
"applicationRoles": {
"items": [],
"size": 1
},
"avatarUrls": {
"16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
"24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
"32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
"48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
},
"displayName": "Mia Krystof",
"emailAddress": "mia@example.com",
"groups": {
"items": [],
"size": 3
},
"key": "",
"name": "",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
"timeZone": "Australia/Sydney"
},
"name": "Example workflow scheme",
"originalDefaultWorkflow": "jira",
"originalIssueTypeMappings": {
"10001": "builds workflow"
},
"self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"
}Returns the issue type-workflow mapping for an issue type in a workflow scheme's draft.
Permissions required: Administer Jira global permission.
manage:jira-configurationread:workflow-scheme:jira, read:workflow:jira, read:issue-type:jiraConnect app scope required: ADMIN
integer
Requiredstring
RequiredReturned if the request is successful.
Details about the mapping between an issue type and a 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}/draft/issuetype/{issueType}`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
{
"issueType": "10000",
"workflow": "jira"
}Sets the workflow for an issue type in a workflow scheme's draft.
Permissions required: Administer Jira global permission.
manage:jira-configurationwrite:workflow-scheme:jira, read:workflow-scheme:jira, read:workflow:jira, read:application-role:jira, read:avatar:jira ...(Show more)Connect app scope required: ADMIN
integer
Requiredstring
RequiredThe issue type-project mapping.
string
boolean
string
Returned if the request is successful.
Details about a workflow scheme.
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}/draft/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());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
{
"defaultWorkflow": "scrum workflow",
"description": "The description of the example workflow scheme.",
"draft": true,
"id": 17218781,
"issueTypeMappings": {
"10000": "jira",
"10001": "jira"
},
"lastModified": "Today 6:38 PM",
"lastModifiedUser": {
"accountId": "5b10a2844c20165700ede21g",
"accountType": "atlassian",
"active": true,
"applicationRoles": {
"items": [],
"size": 1
},
"avatarUrls": {
"16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
"24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
"32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
"48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
},
"displayName": "Mia Krystof",
"emailAddress": "mia@example.com",
"groups": {
"items": [],
"size": 3
},
"key": "",
"name": "",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
"timeZone": "Australia/Sydney"
},
"name": "Example workflow scheme",
"originalDefaultWorkflow": "jira",
"originalIssueTypeMappings": {
"10001": "builds workflow"
},
"self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"
}Deletes the issue type-workflow mapping for an issue type in a workflow scheme's draft.
Permissions required: Administer Jira global permission.
manage:jira-configurationdelete:workflow-scheme:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type:jira ...(Show more)Connect app scope required: ADMIN
integer
Requiredstring
RequiredReturned if the request is successful.
Details about a workflow scheme.
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}/draft/issuetype/{issueType}`, {
method: 'DELETE',
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());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
{
"defaultWorkflow": "scrum workflow",
"description": "The description of the example workflow scheme.",
"draft": true,
"id": 17218781,
"issueTypeMappings": {
"10000": "jira",
"10001": "jira"
},
"lastModified": "Today 6:38 PM",
"lastModifiedUser": {
"accountId": "5b10a2844c20165700ede21g",
"accountType": "atlassian",
"active": true,
"applicationRoles": {
"items": [],
"size": 1
},
"avatarUrls": {
"16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
"24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
"32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
"48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
},
"displayName": "Mia Krystof",
"emailAddress": "mia@example.com",
"groups": {
"items": [],
"size": 3
},
"key": "",
"name": "",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
"timeZone": "Australia/Sydney"
},
"name": "Example workflow scheme",
"originalDefaultWorkflow": "jira",
"originalIssueTypeMappings": {
"10001": "builds workflow"
},
"self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/17218781/draft"
}Publishes a draft workflow scheme.
Where the draft workflow includes new workflow statuses for an issue type, mappings are provided to update issues with the original workflow status to the new workflow status.
This operation is asynchronous. Follow the location link in the response to determine the status of the task and use Get task to obtain updates.
Permissions required: Administer Jira global permission.
manage:jira-configurationwrite:workflow-scheme:jiraConnect app scope required: ADMIN
integer
Requiredboolean
Details of the status mappings.
array<StatusMapping>
Returned if the request is only for validation and is successful.
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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"statusMappings": [
{
"issueTypeId": "10001",
"newStatusId": "1",
"statusId": "3"
},
{
"issueTypeId": "10001",
"newStatusId": "2",
"statusId": "2"
},
{
"issueTypeId": "10002",
"newStatusId": "10003",
"statusId": "10005"
},
{
"issueTypeId": "10003",
"newStatusId": "1",
"statusId": "4"
}
]
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/workflowscheme/{id}/draft/publish`, {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Returns the workflow-issue type mappings for a workflow scheme's draft.
Permissions required: Administer Jira global permission.
manage:jira-configurationread:workflow-scheme:jira, read:workflow:jira, read:issue-type:jiraConnect app scope required: ADMIN
integer
Requiredstring
Returned if the request is successful.
Details about the mapping between issue types and a 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}/draft/workflow`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
{
"defaultMapping": false,
"issueTypes": [
"10000",
"10001"
],
"workflow": "jira"
}Sets the issue types for a workflow in a workflow scheme's draft. The workflow can also be set as the default workflow for the draft workflow scheme. Unmapped issues types are mapped to the default workflow.
Permissions required: Administer Jira global permission.
manage:jira-configurationwrite:workflow-scheme:jira, read:workflow-scheme:jira, read:workflow:jira, read:application-role:jira, read:avatar:jira ...(Show more)Connect app scope required: ADMIN
integer
Requiredstring
Requiredboolean
array<string>
boolean
string
Returned if the request is successful.
Details about a workflow scheme.
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}/draft/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());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"
}Deletes the workflow-issue type mapping for a workflow in a workflow scheme's draft.
Permissions required: Administer Jira global permission.
manage:jira-configurationdelete:workflow-scheme:jiraConnect app scope required: ADMIN
integer
Requiredstring
RequiredReturned if the request is successful.
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}/draft/workflow?workflowName={workflowName}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Rate this page: