This resource represents the associations between workflow schemes and projects.
For more information, see Managing your workflows.
Returns a list of the workflow schemes associated with a list of projects. Each returned workflow scheme includes a list of the requested projects associated with it. Any team-managed or non-existent projects in the request are ignored and no errors are returned.
If the project is associated with the Default Workflow Scheme no ID is returned. This is because the way the Default Workflow Scheme is stored means it has no ID.
Permissions required: Administer Jira global permission.
manage:jira-configurationread:workflow-scheme:jira, read:workflow:jira, read:application-role:jira, read:avatar:jira, read:group:jira ...(Show more)Connect app scope required: ADMIN
array<integer>
RequiredReturned if the request is successful.
A container for a list of workflow schemes together with the projects they are associated with.
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/project?projectId={projectId}`, {
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
{
"values": [
{
"projectIds": [
"10010",
"10020"
],
"workflowScheme": {
"defaultWorkflow": "jira",
"description": "The description of the example workflow scheme.",
"id": 101010,
"issueTypeMappings": {
"10000": "scrum workflow",
"10001": "builds workflow"
},
"name": "Example workflow scheme",
"self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
}
}
]
}Assigns a workflow scheme to a project. This operation is performed only when there are no issues in the project.
Workflow schemes can only be assigned to classic projects.
Permissions required: Administer Jira global permission.
manage:jira-configurationwrite:workflow-scheme:jiraConnect app scope required: ADMIN
string
Requiredstring
Returned if the request is successful.
any
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 = `{
"projectId": "10001",
"workflowSchemeId": "10032"
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/workflowscheme/project`, {
method: 'PUT',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Rate this page: