Class TeamsInPlan

Index

Constructors

Methods

addAtlassianTeam createPlanOnlyTeam deletePlanOnlyTeam getAtlassianTeam getPlanOnlyTeam getTeams removeAtlassianTeam updateAtlassianTeam updatePlanOnlyTeam

Constructors

constructor

new TeamsInPlan(client: Client): Version3.TeamsInPlan
Parameters
- client: Client
Returns Version3.TeamsInPlan
- Defined in src/version3/teamsInPlan.ts:8

Methods

addAtlassianTeam

addAtlassianTeam<T = void>(
parameters: Version3Parameters.AddAtlassianTeam,
callback: Callback<T>,
): Promise<void>
Adds an existing Atlassian team to a plan and configures their plannning settings.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.AddAtlassianTeam
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/teamsInPlan.ts:54
addAtlassianTeam<T = void>(
parameters: Version3Parameters.AddAtlassianTeam,
callback?: undefined,
): Promise<T>
Adds an existing Atlassian team to a plan and configures their plannning settings.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.AddAtlassianTeam
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/teamsInPlan.ts:61

createPlanOnlyTeam

createPlanOnlyTeam<T = unknown>(
parameters: Version3Parameters.CreatePlanOnlyTeam,
callback: Callback<T>,
): Promise<void>
Creates a plan-only team and configures their planning settings.

Permissions required: Administer Jira global permission.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.CreatePlanOnlyTeam
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/teamsInPlan.ts:186
createPlanOnlyTeam<T = unknown>(
parameters: Version3Parameters.CreatePlanOnlyTeam,
callback?: undefined,
): Promise<T>
Creates a plan-only team and configures their planning settings.

Permissions required: Administer Jira global permission.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.CreatePlanOnlyTeam
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/teamsInPlan.ts:196

deletePlanOnlyTeam

deletePlanOnlyTeam<T = void>(
parameters: Version3Parameters.DeletePlanOnlyTeam,
callback: Callback<T>,
): Promise<void>
Deletes a plan-only team and their planning settings.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeletePlanOnlyTeam
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/teamsInPlan.ts:303
deletePlanOnlyTeam<T = void>(
parameters: Version3Parameters.DeletePlanOnlyTeam,
callback?: undefined,
): Promise<T>
Deletes a plan-only team and their planning settings.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeletePlanOnlyTeam
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/teamsInPlan.ts:310

getAtlassianTeam

getAtlassianTeam<T = Version3Models.GetAtlassianTeamResponse>(
parameters: Version3Parameters.GetAtlassianTeam,
callback: Callback<T>,
): Promise<void>
Returns planning settings for an Atlassian team in a plan.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.GetAtlassianTeamResponse
Parameters
- parameters: Version3Parameters.GetAtlassianTeam
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/teamsInPlan.ts:84
getAtlassianTeam<T = Version3Models.GetAtlassianTeamResponse>(
parameters: Version3Parameters.GetAtlassianTeam,
callback?: undefined,
): Promise<T>
Returns planning settings for an Atlassian team in a plan.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.GetAtlassianTeamResponse
Parameters
- parameters: Version3Parameters.GetAtlassianTeam
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/teamsInPlan.ts:94

getPlanOnlyTeam

getPlanOnlyTeam<T = Version3Models.GetPlanOnlyTeamResponse>(
parameters: Version3Parameters.GetPlanOnlyTeam,
callback: Callback<T>,
): Promise<void>
Returns planning settings for a plan-only team.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.GetPlanOnlyTeamResponse
Parameters
- parameters: Version3Parameters.GetPlanOnlyTeam
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/teamsInPlan.ts:223
getPlanOnlyTeam<T = Version3Models.GetPlanOnlyTeamResponse>(
parameters: Version3Parameters.GetPlanOnlyTeam,
callback?: undefined,
): Promise<T>
Returns planning settings for a plan-only team.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.GetPlanOnlyTeamResponse
Parameters
- parameters: Version3Parameters.GetPlanOnlyTeam
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/teamsInPlan.ts:233

getTeams

getTeams<T = Version3Models.PageWithCursorGetTeamResponseForPage>(
parameters: Version3Parameters.GetTeams,
callback: Callback<T>,
): Promise<void>
Returns a paginated list of plan-only and Atlassian teams in a plan.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageWithCursorGetTeamResponseForPage
Parameters
- parameters: Version3Parameters.GetTeams
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/teamsInPlan.ts:17
getTeams<T = Version3Models.PageWithCursorGetTeamResponseForPage>(
parameters: Version3Parameters.GetTeams,
callback?: undefined,
): Promise<T>
Returns a paginated list of plan-only and Atlassian teams in a plan.

Permissions required: Administer Jira global permission.
Type Parameters
- T = Version3Models.PageWithCursorGetTeamResponseForPage
Parameters
- parameters: Version3Parameters.GetTeams
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/teamsInPlan.ts:28

removeAtlassianTeam

removeAtlassianTeam<T = void>(
parameters: Version3Parameters.RemoveAtlassianTeam,
callback: Callback<T>,
): Promise<void>
Removes an Atlassian team from a plan and deletes their planning settings.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.RemoveAtlassianTeam
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/teamsInPlan.ts:160
removeAtlassianTeam<T = void>(
parameters: Version3Parameters.RemoveAtlassianTeam,
callback?: undefined,
): Promise<T>
Removes an Atlassian team from a plan and deletes their planning settings.

Permissions required: Administer Jira global permission.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.RemoveAtlassianTeam
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/teamsInPlan.ts:167

updateAtlassianTeam

updateAtlassianTeam<T = void>(
parameters: Version3Parameters.UpdateAtlassianTeam,
callback: Callback<T>,
): 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.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdateAtlassianTeam
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/teamsInPlan.ts:125
updateAtlassianTeam<T = void>(
parameters: Version3Parameters.UpdateAtlassianTeam,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdateAtlassianTeam
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/teamsInPlan.ts:141

updatePlanOnlyTeam

updatePlanOnlyTeam<T = void>(
parameters: Version3Parameters.UpdatePlanOnlyTeam,
callback: Callback<T>,
): 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.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdatePlanOnlyTeam
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/teamsInPlan.ts:266
updatePlanOnlyTeam<T = void>(
parameters: Version3Parameters.UpdatePlanOnlyTeam,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.UpdatePlanOnlyTeam
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/teamsInPlan.ts:284

Class TeamsInPlan

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.TeamsInPlan

Methods

addAtlassianTeam

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

createPlanOnlyTeam

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deletePlanOnlyTeam

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getAtlassianTeam

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getPlanOnlyTeam

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getTeams

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

removeAtlassianTeam

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

updateAtlassianTeam

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

updatePlanOnlyTeam

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page