This resource represents planning settings for plan-only and Atlassian teams in a plan. Use it to get, create, update and delete planning settings.
Returns a paginated list of plan-only and Atlassian teams in a plan.
Permissions required: Administer Jira global permission.
read:jira-workConnect app scope required: ADMIN
integer
Requiredstring
integer
Returned if the request is successful.
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/plans/plan/{planId}/team`, {
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
{
"cursor": "",
"isLast": true,
"maxResults": 2,
"nextPageCursor": "2",
"total": 10,
"values": [
{
"id": "1",
"name": "Team 1",
"type": "PlanOnly"
},
{
"id": "2",
"type": "Atlassian"
}
]
}Adds an existing Atlassian team to a plan and configures their plannning settings.
Permissions required: Administer Jira global permission.
write:jira-workConnect app scope required: ADMIN
integer
Requirednumber
string
Requiredinteger
string
Requiredinteger
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
21
22
23
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"capacity": 200,
"id": "AtlassianTeamId",
"issueSourceId": 0,
"planningStyle": "Scrum",
"sprintLength": 2
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/plans/plan/{planId}/team/atlassian`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Returns planning settings for an Atlassian team in a plan.
Permissions required: Administer Jira global permission.
read:jira-workConnect app scope required: ADMIN
integer
Requiredstring
RequiredReturned if the request is successful.
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/plans/plan/{planId}/team/atlassian/{atlassianTeamId}`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
{
"capacity": 220,
"id": "98WA-2JBO-12N3-2298",
"issueSourceId": 1,
"planningStyle": "Scrum",
"sprintLength": 2
}Updates any of the following planning settings of an Atlassian team in a plan using JSON Patch.
Permissions required: Administer Jira global permission.
Note that "add" operations do not respect array indexes in target locations. Call the "Get Atlassian team in plan" endpoint to find out the order of array elements.
write:jira-workConnect app scope required: ADMIN
integer
Requiredstring
Requiredobject
Returned if the request is successful.
any
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/plans/plan/{planId}/team/atlassian/{atlassianTeamId}`, {
method: 'PUT',
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Removes an Atlassian team from a plan and deletes their planning settings.
Permissions required: Administer Jira global permission.
write:jira-workConnect app scope required: ADMIN
integer
Requiredstring
RequiredReturned if the request is successful.
any
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/plans/plan/{planId}/team/atlassian/{atlassianTeamId}`, {
method: 'DELETE',
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Creates a plan-only team and configures their planning settings.
Permissions required: Administer Jira global permission.
write:jira-workConnect app scope required: ADMIN
integer
Requirednumber
integer
array<string>
string
Requiredstring
Requiredinteger
Returned if the request is successful.
integer
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
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
var bodyData = `{
"capacity": 200,
"issueSourceId": 0,
"memberAccountIds": [
"member1AccountId",
"member2AccountId"
],
"name": "Team1",
"planningStyle": "Scrum",
"sprintLength": 2
}`;
const response = await api.asUser().requestJira(route`/rest/api/3/plans/plan/{planId}/team/planonly`, {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json'
},
body: bodyData
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Returns planning settings for a plan-only team.
Permissions required: Administer Jira global permission.
read:jira-workConnect app scope required: ADMIN
integer
Requiredinteger
RequiredReturned if the request is successful.
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/plans/plan/{planId}/team/planonly/{planOnlyTeamId}`, {
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
{
"capacity": 30,
"id": 123,
"issueSourceId": 1,
"memberAccountIds": [
"mek2-3jno-01n3",
"kdsn-2nk3-2nn1"
],
"name": "Team1",
"planningStyle": "Scrum",
"sprintLength": 2
}Updates any of the following planning settings of a plan-only team using JSON Patch.
Permissions required: Administer Jira global permission.
Note that "add" operations do not respect array indexes in target locations. Call the "Get plan-only team" endpoint to find out the order of array elements.
write:jira-workConnect app scope required: ADMIN
integer
Requiredinteger
Requiredobject
Returned if the request is successful.
any
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/plans/plan/{planId}/team/planonly/{planOnlyTeamId}`, {
method: 'PUT',
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Deletes a plan-only team and their planning settings.
Permissions required: Administer Jira global permission.
write:jira-workConnect app scope required: ADMIN
integer
Requiredinteger
RequiredReturned if the request is successful.
any
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/plans/plan/{planId}/team/planonly/{planOnlyTeamId}`, {
method: 'DELETE',
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());Rate this page: