Class TemplatesApi

Hierarchy

TemplatesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TemplatesApi(basePath?: string): TemplatesApi

- Defined in api/api.ts:74495
Parameters
- Optional basePath: string
Returns TemplatesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

createTemplate

createTemplate(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkItemTemplate>

- Defined in api/api.ts:74512
Creates a template

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

deleteTemplate

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

- Defined in api/api.ts:74577
Deletes a build definition template.

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

deleteTemplate_1

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

- Defined in api/api.ts:74636
Deletes the template with given id

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

getTemplate

getTemplate(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<BuildDefinitionTemplate>

- Defined in api/api.ts:74699
Gets a specific build definition template.

Parameters
- params: object
  - apiVersion: string
  - organization: string
  - project: string
  - templateId: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<BuildDefinitionTemplate>

getTemplate_2

getTemplate_2(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkItemTemplate>

- Defined in api/api.ts:74758
Gets the template with specified id

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

getTemplates

getTemplates(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<BuildDefinitionTemplate>>

- Defined in api/api.ts:74820
Gets all definition templates.

Parameters
- params: object
  - apiVersion: string
  - organization: string
  - project: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ArrayWrapper<BuildDefinitionTemplate>>

getTemplates_3

getTemplates_3(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<WorkItemTemplateReference>>

- Defined in api/api.ts:74874
Gets template

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

replaceTemplate

replaceTemplate(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkItemTemplate>

- Defined in api/api.ts:74938
Replace template contents

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

saveTemplate

saveTemplate(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<BuildDefinitionTemplate>

- Defined in api/api.ts:75009
Updates an existing build definition template.

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

Generated using TypeDoc