Class FieldsApi

Hierarchy

FieldsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new FieldsApi(basePath?: string): FieldsApi

- Defined in api/api.ts:44481
Parameters
- Optional basePath: string
Returns FieldsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

addFieldToWorkItemType

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

- Defined in api/api.ts:44498
Adds a field to a work item type.

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

createField

createField(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<FieldModel>

- Defined in api/api.ts:44563
Creates a single field in the process.

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

createField_1

createField_1(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkItemField>

- Defined in api/api.ts:44623
Create a new field.

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

deleteField

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

- Defined in api/api.ts:44683
Deletes the field.

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

getAllWorkItemTypeFields

getAllWorkItemTypeFields(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<ProcessWorkItemTypeField>>

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

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

getField

getField(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<WorkItemField>

- Defined in api/api.ts:44799
Gets information on a specific field.

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

getFields

getFields(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<WorkItemField>>

- Defined in api/api.ts:44857
Returns information for all fields.

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

getWorkItemTypeField

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

- Defined in api/api.ts:44915
Returns a field in a work item type.

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

removeWorkItemTypeField

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

- Defined in api/api.ts:44979
Removes a field from a work item type. Does not permanently delete the field.

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

updateField

updateField(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<FieldModel>

- Defined in api/api.ts:45042
Updates a given field in the process.

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

updateWorkItemTypeField

updateWorkItemTypeField(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ProcessWorkItemTypeField>

- Defined in api/api.ts:45104
Updates a field in a work item type.

Parameters
- params: object
  - apiVersion: string
  - body: UpdateProcessWorkItemTypeFieldRequest
  - fieldRefName: string
  - organization: string
  - processId: string
  - witRefName: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ProcessWorkItemTypeField>

Generated using TypeDoc