Class WorkItemTypesApi

Hierarchy

WorkItemTypesApi

Constructors

constructor

new WorkItemTypesApi(basePath?: string): WorkItemTypesApi

- Defined in api/api.ts:82060
Parameters
- Optional basePath: string
Returns WorkItemTypesApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

addBehaviorToWorkItemType

addBehaviorToWorkItemType(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkItemTypeBehavior>

- Defined in api/api.ts:82077
Adds a behavior to the work item type of the process.

Parameters
- params: object
  - apiVersion: string
  - body: WorkItemTypeBehavior
  - organization: string
  - processId: string
  - witRefNameForBehaviors: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<WorkItemTypeBehavior>

createProcessWorkItemType

createProcessWorkItemType(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ProcessWorkItemType>

- Defined in api/api.ts:82142
Creates a work item type in the process.

Parameters
- params: object
  - apiVersion: string
  - body: CreateProcessWorkItemTypeRequest
  - organization: string
  - processId: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ProcessWorkItemType>

createWorkItemType

createWorkItemType(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkItemTypeModel>

- Defined in api/api.ts:82202
Creates a work item type in the process.

Parameters
- params: object
  - apiVersion: string
  - body: WorkItemTypeModel
  - organization: string
  - processId: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<WorkItemTypeModel>

deleteProcessWorkItemType

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

- Defined in api/api.ts:82262
Removes a work itewm type in the process.

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

deleteWorkItemType

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

- Defined in api/api.ts:82320
Removes a work itewm type in the process.

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

getBehaviorForWorkItemType

getBehaviorForWorkItemType(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkItemTypeBehavior>

- Defined in api/api.ts:82379
Returns a behavior for the work item type of the process.

Parameters
- params: object
  - apiVersion: string
  - behaviorRefName: string
  - organization: string
  - processId: string
  - witRefNameForBehaviors: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<WorkItemTypeBehavior>

getBehaviorsForWorkItemType

getBehaviorsForWorkItemType(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<WorkItemTypeBehavior>>

- Defined in api/api.ts:82442
Returns a list of all behaviors for the work item type of the process.

Parameters
- params: object
  - apiVersion: string
  - organization: string
  - processId: string
  - witRefNameForBehaviors: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ArrayWrapper<WorkItemTypeBehavior>>

getProcessWorkItemType

getProcessWorkItemType(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ProcessWorkItemType>

- Defined in api/api.ts:82501
Returns a single work item type in a process.

Parameters
- params: object
  - Optional $Expand?: string
  - apiVersion: string
  - organization: string
  - processId: string
  - witRefName: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ProcessWorkItemType>

getProcessWorkItemTypes

getProcessWorkItemTypes(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<ProcessWorkItemType>>

- Defined in api/api.ts:82563
Returns a list of all work item types in a process.

Parameters
- params: object
  - Optional $Expand?: string
  - apiVersion: string
  - organization: string
  - processId: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ArrayWrapper<ProcessWorkItemType>>

getWorkItemType

getWorkItemType(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkItemTypeModel>

- Defined in api/api.ts:82621
Returns a work item type of the process.

Parameters
- params: object
  - Optional $Expand?: string
  - apiVersion: string
  - organization: string
  - processId: string
  - witRefName: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<WorkItemTypeModel>

getWorkItemType_1

getWorkItemType_1(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkItemType>

- Defined in api/api.ts:82683
Returns a work item type definition.

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

getWorkItemTypes

getWorkItemTypes(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<WorkItemTypeModel>>

- Defined in api/api.ts:82741
Returns a list of all work item types in the process.

Parameters
- params: object
  - Optional $Expand?: string
  - apiVersion: string
  - organization: string
  - processId: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ArrayWrapper<WorkItemTypeModel>>

getWorkItemTypes_2

getWorkItemTypes_2(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<WorkItemType>>

- Defined in api/api.ts:82797
Returns the list of work item types

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

removeBehaviorFromWorkItemType

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

- Defined in api/api.ts:82851
Removes a behavior for the work item type of the process.

Parameters
- params: object
  - apiVersion: string
  - behaviorRefName: string
  - organization: string
  - processId: string
  - witRefNameForBehaviors: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

updateBehaviorToWorkItemType

updateBehaviorToWorkItemType(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkItemTypeBehavior>

- Defined in api/api.ts:82915
Updates a behavior for the work item type of the process.

Parameters
- params: object
  - apiVersion: string
  - body: WorkItemTypeBehavior
  - organization: string
  - processId: string
  - witRefNameForBehaviors: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<WorkItemTypeBehavior>

updateProcessWorkItemType

updateProcessWorkItemType(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ProcessWorkItemType>

- Defined in api/api.ts:82981
Updates a work item type of the process.

Parameters
- params: object
  - apiVersion: string
  - body: UpdateProcessWorkItemTypeRequest
  - organization: string
  - processId: string
  - witRefName: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ProcessWorkItemType>

updateWorkItemType

updateWorkItemType(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkItemTypeModel>

- Defined in api/api.ts:83047
Updates a work item type of the process.

Parameters
- params: object
  - apiVersion: string
  - body: WorkItemTypeUpdateModel
  - organization: string
  - processId: string
  - witRefName: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<WorkItemTypeModel>

Generated using TypeDoc