Class TeamsInPlanService

This resource represents planning settings for plan-only and Atlassian teams in a plan. Use it to get, create, update and delete planning settings.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan

Hierarchy

CommonHttpService
- TeamsInPlanService

Index

Constructors

constructor

Methods

addAtlassianTeam createPlanOnlyTeam deletePlanOnlyTeam getAtlassianTeam getPlanOnlyTeam getTeams removeAtlassianTeam updateAtlassianTeam updatePlanOnlyTeam initialize

Constructors

constructor

new TeamsInPlanService(getClientInstance): TeamsInPlanService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns TeamsInPlanService
Inherited from CommonHttpService.constructor

Methods

addAtlassianTeam

addAtlassianTeam(params): Promise<void>
Adds an existing Atlassian team to a plan and configures their plannning settings.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  addAtlassianTeamRequest: AddAtlassianTeamRequest;
  planId: number;
  }
  - addAtlassianTeamRequest: AddAtlassianTeamRequest
    Example
  - planId: number
    The ID of the plan.
Returns Promise<void>
Returned if the request is successful.

Path
POST /rest/api/3/plans/plan/{planId}/team/atlassian

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan#api-rest-api-3-plans-plan-planid-team-atlassian-post

createPlanOnlyTeam

createPlanOnlyTeam(params): Promise<number>
Creates a plan-only team and configures their planning settings.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  createPlanOnlyTeamRequest: CreatePlanOnlyTeamRequest;
  planId: number;
  }
  - createPlanOnlyTeamRequest: CreatePlanOnlyTeamRequest
    Example
  - planId: number
    The ID of the plan.
Returns Promise<number>
Returned if the request is successful.

Path
POST /rest/api/3/plans/plan/{planId}/team/planonly

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan#api-rest-api-3-plans-plan-planid-team-planonly-post

deletePlanOnlyTeam

deletePlanOnlyTeam(params): Promise<void>
Deletes a plan-only team and their planning settings.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  planId: number;
  planOnlyTeamId: number;
  }
  - planId: number
    The ID of the plan.
  - planOnlyTeamId: number
    The ID of the plan-only team.
Returns Promise<void>
Returned if the request is successful.

Path
DELETE /rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan#api-rest-api-3-plans-plan-planid-team-planonly-planonlyteamid-delete

getAtlassianTeam

getAtlassianTeam(params): Promise<GetAtlassianTeamResponse>
Returns planning settings for an Atlassian team in a plan.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  atlassianTeamId: string;
  planId: number;
  }
  - atlassianTeamId: string
    The ID of the Atlassian team.
  - planId: number
    The ID of the plan.
Returns Promise<GetAtlassianTeamResponse>
Returned if the request is successful.

example:
```
{
  "capacity": 220,
  "id": "98WA-2JBO-12N3-2298",
  "issueSourceId": 1,
  "planningStyle": "Scrum",
  "sprintLength": 2
}
```
Path
GET /rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan#api-rest-api-3-plans-plan-planid-team-atlassian-atlassianteamid-get

getPlanOnlyTeam

getPlanOnlyTeam(params): Promise<GetPlanOnlyTeamResponse>
Returns planning settings for a plan-only team.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  planId: number;
  planOnlyTeamId: number;
  }
  - planId: number
    The ID of the plan.
  - planOnlyTeamId: number
    The ID of the plan-only team.
Returns Promise<GetPlanOnlyTeamResponse>
Returned if the request is successful.

example:
```
{
  "capacity": 30,
  "id": 123,
  "issueSourceId": 1,
  "memberAccountIds": [
    "mek2-3jno-01n3",
    "kdsn-2nk3-2nn1"
  ],
  "name": "Team1",
  "planningStyle": "Scrum",
  "sprintLength": 2
}
```
Path
GET /rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan#api-rest-api-3-plans-plan-planid-team-planonly-planonlyteamid-get

getTeams

getTeams(params): Promise<PageWithCursorGetTeamResponseForPage>
Returns a paginated list of plan-only and Atlassian teams in a plan.

Permissions required: Administer Jira global permission.
Parameters
- params: {
      cursor?: string;
      maxResults?: number;
      planId: number;
  }
  - Optionalcursor?: string
    The cursor to start from. If not provided, the first page will be returned.
  - OptionalmaxResults?: number
    The maximum number of plan teams to return per page. The maximum value is 50. The default value is 50.
  - planId: number
    The ID of the plan.
Returns Promise<PageWithCursorGetTeamResponseForPage>
Returned if the request is successful.

example:
```
{
  "cursor": "",
  "isLast": true,
  "maxResults": 2,
  "nextPageCursor": "2",
  "total": 10,
  "values": [
    {
      "id": "1",
      "name": "Team 1",
      "type": "PlanOnly"
    },
    {
      "id": "2",
      "type": "Atlassian"
    }
  ]
}
```
Path
GET /rest/api/3/plans/plan/{planId}/team

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan#api-rest-api-3-plans-plan-planid-team-get

removeAtlassianTeam

removeAtlassianTeam(params): Promise<void>
Removes an Atlassian team from a plan and deletes their planning settings.

Permissions required: Administer Jira global permission.
Parameters
- params: {
  atlassianTeamId: string;
  planId: number;
  }
  - atlassianTeamId: string
    The ID of the Atlassian team.
  - planId: number
    The ID of the plan.
Returns Promise<void>
Returned if the request is successful.

Path
DELETE /rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan#api-rest-api-3-plans-plan-planid-team-atlassian-atlassianteamid-delete

updateAtlassianTeam

updateAtlassianTeam(params): Promise<void>
Updates any of the following planning settings of an Atlassian team in a plan using JSON Patch.
- planningStyle
- issueSourceId
- sprintLength
- capacity
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.
Parameters
- params: {
      atlassianTeamId: string;
      planId: number;
      requestBody: {
          [key: string]: unknown;
      };
  }
  - atlassianTeamId: string
    The ID of the Atlassian team.
  - planId: number
    The ID of the plan.
  - requestBody: {
    [key: string]: unknown;
    }
    Example
    [ { "op": "replace", "path": "/planningStyle", "value": "Kanban" } ]
    - [key: string]: unknown
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/plans/plan/{planId}/team/atlassian/{atlassianTeamId}

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan#api-rest-api-3-plans-plan-planid-team-atlassian-atlassianteamid-put

updatePlanOnlyTeam

updatePlanOnlyTeam(params): Promise<void>
Updates any of the following planning settings of a plan-only team using JSON Patch.
- name
- planningStyle
- issueSourceId
- sprintLength
- capacity
- memberAccountIds
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.
Parameters
- params: {
      planId: number;
      planOnlyTeamId: number;
      requestBody: {
          [key: string]: unknown;
      };
  }
  - planId: number
    The ID of the plan.
  - planOnlyTeamId: number
    The ID of the plan-only team.
  - requestBody: {
    [key: string]: unknown;
    }
    Example
    [ { "op": "replace", "path": "/planningStyle", "value": "Kanban" } ]
    - [key: string]: unknown
Returns Promise<void>
Returned if the request is successful.

Path
PUT /rest/api/3/plans/plan/{planId}/team/planonly/{planOnlyTeamId}

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan#api-rest-api-3-plans-plan-planid-team-planonly-planonlyteamid-put

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class TeamsInPlanService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns TeamsInPlanService

Methods

addAtlassianTeam

Parameters

addAtlassianTeamRequest: AddAtlassianTeamRequest

Example

planId: number

Returns Promise<void>

Path

See

createPlanOnlyTeam

Parameters

createPlanOnlyTeamRequest: CreatePlanOnlyTeamRequest

Example

planId: number

Returns Promise<number>

Path

See

deletePlanOnlyTeam

Parameters

planId: number

planOnlyTeamId: number

Returns Promise<void>

Path

See

getAtlassianTeam

Parameters

atlassianTeamId: string

planId: number

Returns Promise<GetAtlassianTeamResponse>

Path

See

getPlanOnlyTeam

Parameters

planId: number

planOnlyTeamId: number

Returns Promise<GetPlanOnlyTeamResponse>

Path

See

getTeams

Parameters

Optionalcursor?: string

OptionalmaxResults?: number

planId: number

Returns Promise<PageWithCursorGetTeamResponseForPage>

Path

See

removeAtlassianTeam

Parameters

atlassianTeamId: string

planId: number

Returns Promise<void>

Path

See

updateAtlassianTeam

Parameters

atlassianTeamId: string

planId: number

requestBody: { [key: string]: unknown; }

Example

[key: string]: unknown

Returns Promise<void>

Path

See

updatePlanOnlyTeam

Parameters

planId: number

planOnlyTeamId: number

requestBody: { [key: string]: unknown; }

Example

`Optional`cursor?: string

`Optional`maxResults?: number

requestBody: {
[key: string]: unknown;
}

requestBody: {
[key: string]: unknown;
}

`Protected` `Static`initialize