Class WorkItemTypesFieldsApi

Hierarchy

WorkItemTypesFieldsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WorkItemTypesFieldsApi(basePath?: string): WorkItemTypesFieldsApi

- Defined in api/api.ts:83591
Parameters
- Optional basePath: string
Returns WorkItemTypesFieldsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

addFieldToWorkItemType

addFieldToWorkItemType(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkItemTypeFieldModel>

- Defined in api/api.ts:83608
Adds a field to the work item type in the process.

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

getWorkItemTypeField

getWorkItemTypeField(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkItemTypeFieldModel>

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

Parameters
- params: object
  - apiVersion: string
  - fieldRefName: string
  - organization: string
  - processId: string
  - witRefNameForFields: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<WorkItemTypeFieldModel>

getWorkItemTypeFields

getWorkItemTypeFields(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<WorkItemTypeFieldModel>>

- Defined in api/api.ts:83737
Returns a list of all fields in the work item type of the process.

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

removeFieldFromWorkItemType

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

- Defined in api/api.ts:83796
Removes a field in the work item type of the process.

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

Generated using TypeDoc