This resource represents workflow transition properties, which provides for storing custom data against a workflow transition. Use it to get, create, and delete workflow transition properties as well as get a list of property keys for a workflow transition. Workflow transition properties are a type of entity property.
Returns the properties on a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.
Permissions required: Administer Jira global permission.
manage:jira-configurationread:workflow.property:jiraConnect app scope required: ADMIN
integer
Requiredboolean
string
string
Requiredstring
200 response
Details about the server Jira is running on.
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/workflow/transitions/{transitionId}/properties?workflowName={workflowName}`, {
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
[
{
"id": "jira.i18n.title",
"key": "jira.i18n.title",
"value": "some.title"
},
{
"id": "jira.permission",
"key": "jira.permission",
"value": "createissue"
}
]Updates a workflow transition by changing the property value. Trying to update a property that does not exist results in a new property being added to the transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.
Permissions required: Administer Jira global permission.
manage:jira-configurationwrite:workflow.property:jira, read:workflow.property:jiraConnect app scope required: ADMIN
integer
Requiredstring
Requiredstring
Requiredstring
string
Requiredany
200 response
Details about the server Jira is running on.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"value": "createissue"
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/workflow/transitions/{transitionId}/properties?key={key}&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
{
"key": "jira.i18n.title",
"value": "some.title",
"id": "jira.i18n.title"
}Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.
Permissions required: Administer Jira global permission.
manage:jira-configurationwrite:workflow.property:jira, read:workflow.property:jiraConnect app scope required: ADMIN
integer
Requiredstring
Requiredstring
Requiredstring
string
Requiredany
200 response
Details about the server Jira is running on.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"value": "createissue"
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/workflow/transitions/{transitionId}/properties?key={key}&workflowName={workflowName}`, {
method: 'POST',
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
{
"key": "jira.i18n.title",
"value": "some.title",
"id": "jira.i18n.title"
}Deletes a property from a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.
Permissions required: Administer Jira global permission.
manage:jira-configurationdelete:workflow.property:jiraConnect app scope required: ADMIN
integer
Requiredstring
Requiredstring
Requiredstring
200 response
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/workflow/transitions/{transitionId}/properties?key={key}&workflowName={workflowName}`, {
method: 'DELETE'
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());Rate this page: