Class IterationsApi

Hierarchy

IterationsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new IterationsApi(basePath?: string): IterationsApi

- Defined in api/api.ts:48020
Parameters
- Optional basePath: string
Returns IterationsApi

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

deleteTeamIteration

deleteTeamIteration(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:48037
Delete a team's iteration by iterationId

Parameters
- params: object
  - apiVersion: string
  - id: string
  - organization: string
  - project: string
  - team: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

getIterationWorkItems

getIterationWorkItems(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<IterationWorkItems>

- Defined in api/api.ts:48101
Get work items for iteration

Parameters
- params: object
  - apiVersion: string
  - iterationId: string
  - organization: string
  - project: string
  - team: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<IterationWorkItems>

getTeamIteration

getTeamIteration(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<TeamSettingsIteration>

- Defined in api/api.ts:48165
Get team's iteration by iterationId

Parameters
- params: object
  - apiVersion: string
  - id: string
  - organization: string
  - project: string
  - team: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<TeamSettingsIteration>

getTeamIterations

getTeamIterations(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<TeamSettingsIteration>>

- Defined in api/api.ts:48229
Get a team's iterations using timeframe filter

Parameters
- params: object
  - Optional $Timeframe?: string
  - apiVersion: string
  - organization: string
  - project: string
  - team: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ArrayWrapper<TeamSettingsIteration>>

getTestIteration

getTestIteration(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<TestIterationDetailsModel>

- Defined in api/api.ts:48294
Get iteration for a result

Parameters
- params: object
  - apiVersion: string
  - Optional includeActionResults?: boolean
  - iterationId: number
  - organization: string
  - project: string
  - runId: number
  - testCaseResultId: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<TestIterationDetailsModel>

getTestIterations

getTestIterations(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<TestIterationDetailsModel>>

- Defined in api/api.ts:48368
Get iterations for a result

Parameters
- params: object
  - apiVersion: string
  - Optional includeActionResults?: boolean
  - organization: string
  - project: string
  - runId: number
  - testCaseResultId: number
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ArrayWrapper<TestIterationDetailsModel>>

postTeamIteration

postTeamIteration(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<TeamSettingsIteration>

- Defined in api/api.ts:48436
Add an iteration to the team

Parameters
- params: object
  - apiVersion: string
  - body: TeamSettingsIteration
  - organization: string
  - project: string
  - team: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<TeamSettingsIteration>

Generated using TypeDoc