Workflow
Available since v. 1.53.X for Jira Administrators
Since v. 1.58.X:
get workflow transition/transitions by issueKey
added transitionScreenId and transitionStepId parameters
Get all workflow transitions
Method type: GET
URL:
{JIRA_URL}/rest/extender/1.0/workflow/transitions?workflowName={workflowName}
or
{JIRA_URL}/rest/extender/1.0/workflow/transitions?issueKey={issueKey}
where
{workflowName} - workflow name
{issueKey} - issue key
Parameters:
workflowMode - optional - draft, live or empty
Example URL:
{JIRA_URL}/rest/extender/1.0/workflow/transitions?workflowName=jira
{JIRA_URL}/rest/extender/1.0/workflow/transitions?workflowName=new_workflow&workflowMode=draft
{JIRA_URL}/rest/extender/1.0/workflow/transitions?issueKey=ABC-123
Response format: JSON
Example response:
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
{
"updateAuthorName": null,
"isSystemWorkflow": true,
"workflowName": "jira",
"isDraftWorkflow": false,
"updatedDate": null,
"workflowDescription": "The default Jira workflow",
"transitions": [
{
"sourceStatus": null,
"transitionScreenId": 12000,
"transitionStepId": 1,
"transitionId": 1,
"isLoop": false,
"destinationStatus": {
"statusId": "1",
"statusCategoryKey": "new",
"statusName": "Open"
},
"isInitialAction": true,
"transitionName": "Create Issue"
},
{
"sourceStatus": [
{
"statusId": "1",
"statusCategoryKey": "new",
"statusName": "Open"
},
{
"statusId": "3",
"statusCategoryKey": "indeterminate",
"statusName": "In Progress"
},
{
"statusId": "4",
"statusCategoryKey": "new",
"statusName": "Reopened"
}
],
"transitionId": 2,
"isLoop": false,
"destinationStatus": {
"statusId": "6",
"statusCategoryKey": "done",
"statusName": "Closed"
},
"transitionName": "Close Issue"
},
{
"sourceStatus": [
{
"statusId": "5",
"statusCategoryKey": "done",
"statusName": "Resolved"
},
{
"statusId": "6",
"statusCategoryKey": "done",
"statusName": "Closed"
}
],
"transitionId": 3,
"isLoop": false,
"destinationStatus": {
"statusId": "4",
"statusCategoryKey": "new",
"statusName": "Reopened"
},
"transitionName": "Reopen Issue"
},
{
"sourceStatus": [
{
"statusId": "1",
"statusCategoryKey": "new",
"statusName": "Open"
},
{
"statusId": "4",
"statusCategoryKey": "new",
"statusName": "Reopened"
}
],
"transitionId": 4,
"isLoop": false,
"destinationStatus": {
"statusId": "3",
"statusCategoryKey": "indeterminate",
"statusName": "In Progress"
},
"transitionName": "Start Progress"
},
{
"sourceStatus": [
{
"statusId": "1",
"statusCategoryKey": "new",
"statusName": "Open"
},
{
"statusId": "3",
"statusCategoryKey": "indeterminate",
"statusName": "In Progress"
},
{
"statusId": "4",
"statusCategoryKey": "new",
"statusName": "Reopened"
}
],
"transitionId": 5,
"isLoop": false,
"destinationStatus": {
"statusId": "5",
"statusCategoryKey": "done",
"statusName": "Resolved"
},
"transitionName": "Resolve Issue"
},
{
"sourceStatus": [
{
"statusId": "3",
"statusCategoryKey": "indeterminate",
"statusName": "In Progress"
}
],
"transitionId": 301,
"isLoop": false,
"destinationStatus": {
"statusId": "1",
"statusCategoryKey": "new",
"statusName": "Open"
},
"transitionName": "Stop Progress"
},
{
"sourceStatus": [
{
"statusId": "5",
"statusCategoryKey": "done",
"statusName": "Resolved"
}
],
"transitionId": 701,
"isLoop": false,
"destinationStatus": {
"statusId": "6",
"statusCategoryKey": "done",
"statusName": "Closed"
},
"transitionName": "Close Issue"
}
]
}
Get transition informations
Method type: GET
URL:
{JIRA_URL}/rest/extender/1.0/workflow/transition/{transitionIdOrName}?workflowName={workflowName}
or
{JIRA_URL}/rest/extender/1.0/workflow/transition/{transitionIdOrName}?issueKey={issueKey}
where
{transitionIdOrName} - transition name or id
{workflowName} - workflow name
{issueKey} - issue key
Parameters:
workflowMode - optional - draft, live or empty
Example URL:
{JIRA_URL}/rest/extender/1.0/workflow/transition/111?workflowName=jira
{JIRA_URL}/rest/extender/1.0/workflow/transition/111?workflowName=test&workflowMode=draft
{JIRA_URL}/rest/extender/1.0/workflow/transition/111?issueKey=ABC-123
Response format: JSON
Example response:
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
{
"updateAuthorName": "admin",
"isSystemWorkflow": false,
"workflowName": "test",
"isDraftWorkflow": true,
"updatedDate": 1596047650224,
"workflowDescription": "process-management-workflow",
"transition": {
"sourceStatus": [
{
"statusId": "3",
"statusCategoryKey": "indeterminate",
"statusName": "In Progress"
}
],
"transitionId": 111,
"transitionScreenId": 12000,
"transitionStepId": 1,
"postFunctions": [
{
"class.name": "com.atlassian.jira.workflow.function.issue.UpdateIssueStatusFunction"
},
{
"class.name": "com.atlassian.jira.workflow.function.misc.CreateCommentFunction"
},
{
"class.name": "com.atlassian.jira.workflow.function.issue.GenerateChangeHistoryFunction"
},
{
"class.name": "com.atlassian.jira.workflow.function.issue.IssueReindexFunction"
},
{
"eventTypeId": "13",
"class.name": "com.atlassian.jira.workflow.function.event.FireIssueEventFunction"
}
],
"validators": [
{
"selectedCFs": "comment,assignee",
"validationMessage": "Example error",
"bindToFields": "yes",
"class.name": "com.itlab.jira.plugins.extender.workflows.validators.FieldRequired"
}
],
"metaAttributes": {
"jira.i18n.submit": "stopprogress.title",
"jira.description": "",
"jira.i18n.title": "stopprogress.title",
"jira.fieldscreen.id": "10000"
},
"isLoop": false,
"conditions": {
"type": "AND",
"conditions": [
{
"type": "OR",
"conditions": [
[
{
"class.name": "com.atlassian.jira.workflow.condition.AllowOnlyAssignee"
}
],
[
{
"class.name": "com.atlassian.jira.workflow.condition.AllowOnlyReporter"
}
]
]
},
{
"class.name": "com.itlab.jira.plugins.extender.workflows.conditions.HideTransition"
}
]
},
"destinationStatus": {
"statusId": "10003",
"statusCategoryKey": "done",
"statusName": "Cancelled"
},
"transitionName": "Stop progress"
}
}