Class WorkItemTrackingProcessDefinitionsApi

Hierarchy (View Summary)

ClientApiBase
- WorkItemTrackingProcessDefinitionsApi

Implements

IWorkItemTrackingProcessDefinitionsApi

Index

Constructors

constructor

new WorkItemTrackingProcessDefinitionsApi(
    baseUrl: string,
    handlers: IRequestHandler[],
    options?: IRequestOptions,
): WorkItemTrackingProcessDefinitionsApi
Parameters
- baseUrl: string
- handlers: IRequestHandler[]
- Optionaloptions: IRequestOptions
Returns WorkItemTrackingProcessDefinitionsApi
Overrides ClientApiBase.constructor
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:69

Properties

baseUrl

baseUrl: string

http

http: HttpClient

rest

rest: RestClient

userAgent

userAgent: string

vsoClient

vsoClient: VsoClient

`Static` `Readonly`RESOURCE_AREA_ID

RESOURCE_AREA_ID: "5264459e-e5e0-4bd8-b118-0985e68a4ec5"

Methods

addBehaviorToWorkItemType

addBehaviorToWorkItemType(
    behavior: WorkItemTypeBehavior,
    processId: string,
    witRefNameForBehaviors: string,
): Promise<WorkItemTypeBehavior>
Adds a behavior to the work item type of the process.
Parameters
- behavior: WorkItemTypeBehavior
- processId: string
  The ID of the process
- witRefNameForBehaviors: string
  Work item type reference name for the behavior
Returns Promise<WorkItemTypeBehavior>
Implementation of IWorkItemTrackingProcessDefinitionsApi.addBehaviorToWorkItemType
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:1560

addControlToGroup

addControlToGroup(
    control: Control,
    processId: string,
    witRefName: string,
    groupId: string,
): Promise<Control>
Creates a control in a group
Parameters
- control: Control
  The control
- processId: string
  The ID of the process
- witRefName: string
  The reference name of the work item type
- groupId: string
  The ID of the group to add the control to
Returns Promise<Control>
Implementation of IWorkItemTrackingProcessDefinitionsApi.addControlToGroup
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:301

addFieldToWorkItemType

addFieldToWorkItemType(
    field: WorkItemTypeFieldModel2,
    processId: string,
    witRefNameForFields: string,
): Promise<WorkItemTypeFieldModel2>
Adds a field to the work item type in the process.
Parameters
- field: WorkItemTypeFieldModel2
- processId: string
  The ID of the process
- witRefNameForFields: string
  Work item type reference name for the field
Returns Promise<WorkItemTypeFieldModel2>
Implementation of IWorkItemTrackingProcessDefinitionsApi.addFieldToWorkItemType
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:2022

addGroup

addGroup(
    group: Group,
    processId: string,
    witRefName: string,
    pageId: string,
    sectionId: string,
): Promise<Group>
Adds a group to the work item form
Parameters
- group: Group
  The group
- processId: string
  The ID of the process
- witRefName: string
  The reference name of the work item type
- pageId: string
  The ID of the page to add the group to
- sectionId: string
  The ID of the section to add the group to
Returns Promise<Group>
Implementation of IWorkItemTrackingProcessDefinitionsApi.addGroup
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:598

addPage

addPage(page: Page, processId: string, witRefName: string): Promise<Page>
Adds a page to the work item form
Parameters
- page: Page
  The page
- processId: string
  The ID of the process
- witRefName: string
  The reference name of the work item type
Returns Promise<Page>
Implementation of IWorkItemTrackingProcessDefinitionsApi.addPage
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:1139

createAcceptHeader

createAcceptHeader(type: string, apiVersion?: string): string
Parameters
- type: string
- OptionalapiVersion: string
Returns string
Implementation of IWorkItemTrackingProcessDefinitionsApi.createAcceptHeader
Inherited from ClientApiBase.createAcceptHeader
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:30

createBehavior

createBehavior(
behavior: BehaviorCreateModel,
processId: string,
): Promise<BehaviorModel>
Creates a single behavior in the given process.
Parameters
- behavior: BehaviorCreateModel
- processId: string
  The ID of the process
Returns Promise<BehaviorModel>
Implementation of IWorkItemTrackingProcessDefinitionsApi.createBehavior
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:81

createField

createField(field: FieldModel, processId: string): Promise<FieldModel>
Creates a single field in the process.
Parameters
- field: FieldModel
- processId: string
  The ID of the process
Returns Promise<FieldModel>
Implementation of IWorkItemTrackingProcessDefinitionsApi.createField
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:509

createList

createList(picklist: PickListModel): Promise<PickListModel>
Creates a picklist.
Parameters
- picklist: PickListModel
Returns Promise<PickListModel>
Implementation of IWorkItemTrackingProcessDefinitionsApi.createList
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:972

createRequestOptions

createRequestOptions(type: string, apiVersion?: string): IRequestOptions
Parameters
- type: string
- OptionalapiVersion: string
Returns IRequestOptions
Implementation of IWorkItemTrackingProcessDefinitionsApi.createRequestOptions
Inherited from ClientApiBase.createRequestOptions
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:34

createStateDefinition

createStateDefinition(
    stateModel: WorkItemStateInputModel,
    processId: string,
    witRefName: string,
): Promise<WorkItemStateResultModel>
Creates a state definition in the work item type of the process.
Parameters
- stateModel: WorkItemStateInputModel
- processId: string
  The ID of the process
- witRefName: string
  The reference name of the work item type
Returns Promise<WorkItemStateResultModel>
Implementation of IWorkItemTrackingProcessDefinitionsApi.createStateDefinition
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:1278

createWorkItemType

createWorkItemType(
workItemType: WorkItemTypeModel,
processId: string,
): Promise<WorkItemTypeModel>
Creates a work item type in the process.
Parameters
- workItemType: WorkItemTypeModel
- processId: string
  The ID of the process
Returns Promise<WorkItemTypeModel>
Implementation of IWorkItemTrackingProcessDefinitionsApi.createWorkItemType
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:1789

deleteBehavior

deleteBehavior(processId: string, behaviorId: string): Promise<void>
Removes a behavior in the process.
Parameters
- processId: string
  The ID of the process
- behaviorId: string
  The ID of the behavior
Returns Promise<void>
Implementation of IWorkItemTrackingProcessDefinitionsApi.deleteBehavior
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:124

deleteList

deleteList(listId: string): Promise<void>
Removes a picklist.
Parameters
- listId: string
  The ID of the list
Returns Promise<void>
Implementation of IWorkItemTrackingProcessDefinitionsApi.deleteList
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:1012

deleteStateDefinition

deleteStateDefinition(
    processId: string,
    witRefName: string,
    stateId: string,
): Promise<void>
Removes a state definition in the work item type of the process.
Parameters
- processId: string
  ID of the process
- witRefName: string
  The reference name of the work item type
- stateId: string
  ID of the state
Returns Promise<void>
Implementation of IWorkItemTrackingProcessDefinitionsApi.deleteStateDefinition
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:1324

deleteWorkItemType

deleteWorkItemType(processId: string, witRefName: string): Promise<void>
Removes a work item type in the process.
Parameters
- processId: string
  The ID of the process
- witRefName: string
  The reference name of the work item type
Returns Promise<void>
Implementation of IWorkItemTrackingProcessDefinitionsApi.deleteWorkItemType
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:1832

editControl

editControl(
    control: Control,
    processId: string,
    witRefName: string,
    groupId: string,
    controlId: string,
): Promise<Control>
Updates a control on the work item form
Parameters
- control: Control
  The updated control
- processId: string
  The ID of the process
- witRefName: string
  The reference name of the work item type
- groupId: string
  The ID of the group
- controlId: string
  The ID of the control
Returns Promise<Control>
Implementation of IWorkItemTrackingProcessDefinitionsApi.editControl
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:351

editGroup

editGroup(
    group: Group,
    processId: string,
    witRefName: string,
    pageId: string,
    sectionId: string,
    groupId: string,
): Promise<Group>
Updates a group in the work item form
Parameters
- group: Group
  The updated group
- processId: string
  The ID of the process
- witRefName: string
  The reference name of the work item type
- pageId: string
  The ID of the page the group is in
- sectionId: string
  The ID of the section the group is in
- groupId: string
  The ID of the group
Returns Promise<Group>
Implementation of IWorkItemTrackingProcessDefinitionsApi.editGroup
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:651

editPage

editPage(page: Page, processId: string, witRefName: string): Promise<Page>
Updates a page on the work item form
Parameters
- page: Page
  The page
- processId: string
  The ID of the process
- witRefName: string
  The reference name of the work item type
Returns Promise<Page>
Implementation of IWorkItemTrackingProcessDefinitionsApi.editPage
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:1185

formatResponse

formatResponse(data: any, responseTypeMetadata: any, isCollection: boolean): any
Parameters
- data: any
- responseTypeMetadata: any
- isCollection: boolean
Returns any
Implementation of IWorkItemTrackingProcessDefinitionsApi.formatResponse
Inherited from ClientApiBase.formatResponse
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:40

getBehavior

getBehavior(processId: string, behaviorId: string): Promise<BehaviorModel>
Returns a single behavior in the process.
Parameters
- processId: string
  The ID of the process
- behaviorId: string
  The ID of the behavior
Returns Promise<BehaviorModel>
Implementation of IWorkItemTrackingProcessDefinitionsApi.getBehavior
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:168

getBehaviorForWorkItemType

getBehaviorForWorkItemType(
    processId: string,
    witRefNameForBehaviors: string,
    behaviorRefName: string,
): Promise<WorkItemTypeBehavior>
Returns a behavior for the work item type of the process.
Parameters
- processId: string
  The ID of the process
- witRefNameForBehaviors: string
  Work item type reference name for the behavior
- behaviorRefName: string
  The reference name of the behavior
Returns Promise<WorkItemTypeBehavior>
Implementation of IWorkItemTrackingProcessDefinitionsApi.getBehaviorForWorkItemType
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:1606

getBehaviors

getBehaviors(processId: string): Promise<BehaviorModel[]>
Returns a list of all behaviors in the process.
Parameters
- processId: string
  The ID of the process
Returns Promise<BehaviorModel[]>
Implementation of IWorkItemTrackingProcessDefinitionsApi.getBehaviors
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:211

getBehaviorsForWorkItemType

getBehaviorsForWorkItemType(
processId: string,
witRefNameForBehaviors: string,
): Promise<WorkItemTypeBehavior[]>
Returns a list of all behaviors for the work item type of the process.
Parameters
- processId: string
  The ID of the process
- witRefNameForBehaviors: string
  Work item type reference name for the behavior
Returns Promise<WorkItemTypeBehavior[]>
Implementation of IWorkItemTrackingProcessDefinitionsApi.getBehaviorsForWorkItemType
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:1652

getFormLayout

getFormLayout(processId: string, witRefName: string): Promise<FormLayout>
Gets the form layout
Parameters
- processId: string
  The ID of the process
- witRefName: string
  The reference name of the work item type
Returns Promise<FormLayout>
Implementation of IWorkItemTrackingProcessDefinitionsApi.getFormLayout
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:891

getList

getList(listId: string): Promise<PickListModel>
Returns a picklist.
Parameters
- listId: string
  The ID of the list
Returns Promise<PickListModel>
Implementation of IWorkItemTrackingProcessDefinitionsApi.getList
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:1053

getListsMetadata

getListsMetadata(): Promise<PickListMetadataModel[]>
Returns meta data of the picklist.

Returns Promise<PickListMetadataModel[]>
Implementation of IWorkItemTrackingProcessDefinitionsApi.getListsMetadata
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:933

getStateDefinition

getStateDefinition(
    processId: string,
    witRefName: string,
    stateId: string,
): Promise<WorkItemStateResultModel>
Returns a state definition in the work item type of the process.
Parameters
- processId: string
  The ID of the process
- witRefName: string
  The reference name of the work item type
- stateId: string
  The ID of the state
Returns Promise<WorkItemStateResultModel>
Implementation of IWorkItemTrackingProcessDefinitionsApi.getStateDefinition
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:1371

getStateDefinitions

getStateDefinitions(
processId: string,
witRefName: string,
): Promise<WorkItemStateResultModel[]>
Returns a list of all state definitions in the work item type of the process.
Parameters
- processId: string
  The ID of the process
- witRefName: string
  The reference name of the work item type
Returns Promise<WorkItemStateResultModel[]>
Implementation of IWorkItemTrackingProcessDefinitionsApi.getStateDefinitions
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:1417

getWorkItemType

getWorkItemType(
    processId: string,
    witRefName: string,
    expand?: GetWorkItemTypeExpand,
): Promise<WorkItemTypeModel>
Returns a work item type of the process.
Parameters
- processId: string
  The ID of the process
- witRefName: string
  The reference name of the work item type
- Optionalexpand: GetWorkItemTypeExpand
Returns Promise<WorkItemTypeModel>
Implementation of IWorkItemTrackingProcessDefinitionsApi.getWorkItemType
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:1877

getWorkItemTypeField

getWorkItemTypeField(
    processId: string,
    witRefNameForFields: string,
    fieldRefName: string,
): Promise<WorkItemTypeFieldModel2>
Returns a single field in the work item type of the process.
Parameters
- processId: string
  The ID of the process
- witRefNameForFields: string
  Work item type reference name for fields
- fieldRefName: string
  The reference name of the field
Returns Promise<WorkItemTypeFieldModel2>
Implementation of IWorkItemTrackingProcessDefinitionsApi.getWorkItemTypeField
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:2068

getWorkItemTypeFields

getWorkItemTypeFields(
processId: string,
witRefNameForFields: string,
): Promise<WorkItemTypeFieldModel2[]>
Returns a list of all fields in the work item type of the process.
Parameters
- processId: string
  The ID of the process
- witRefNameForFields: string
  Work item type reference name for fields
Returns Promise<WorkItemTypeFieldModel2[]>
Implementation of IWorkItemTrackingProcessDefinitionsApi.getWorkItemTypeFields
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:2114

getWorkItemTypes

getWorkItemTypes(
processId: string,
expand?: GetWorkItemTypeExpand,
): Promise<WorkItemTypeModel[]>
Returns a list of all work item types in the process.
Parameters
- processId: string
  The ID of the process
- Optionalexpand: GetWorkItemTypeExpand
Returns Promise<WorkItemTypeModel[]>
Implementation of IWorkItemTrackingProcessDefinitionsApi.getWorkItemTypes
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:1927

hideStateDefinition

hideStateDefinition(
    hideStateModel: HideStateModel,
    processId: string,
    witRefName: string,
    stateId: string,
): Promise<WorkItemStateResultModel>
Hides a state definition in the work item type of the process.
Parameters
- hideStateModel: HideStateModel
- processId: string
  The ID of the process
- witRefName: string
  The reference name of the work item type
- stateId: string
  The ID of the state
Returns Promise<WorkItemStateResultModel>
Implementation of IWorkItemTrackingProcessDefinitionsApi.hideStateDefinition
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:1463

removeBehaviorFromWorkItemType

removeBehaviorFromWorkItemType(
    processId: string,
    witRefNameForBehaviors: string,
    behaviorRefName: string,
): Promise<void>
Removes a behavior for the work item type of the process.
Parameters
- processId: string
  The ID of the process
- witRefNameForBehaviors: string
  Work item type reference name for the behavior
- behaviorRefName: string
  The reference name of the behavior
Returns Promise<void>
Implementation of IWorkItemTrackingProcessDefinitionsApi.removeBehaviorFromWorkItemType
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:1697

removeControlFromGroup

removeControlFromGroup(
    processId: string,
    witRefName: string,
    groupId: string,
    controlId: string,
): Promise<void>
Removes a control from the work item form
Parameters
- processId: string
  The ID of the process
- witRefName: string
  The reference name of the work item type
- groupId: string
  The ID of the group
- controlId: string
  The ID of the control to remove
Returns Promise<void>
Implementation of IWorkItemTrackingProcessDefinitionsApi.removeControlFromGroup
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:402

removeFieldFromWorkItemType

removeFieldFromWorkItemType(
    processId: string,
    witRefNameForFields: string,
    fieldRefName: string,
): Promise<void>
Removes a field in the work item type of the process.
Parameters
- processId: string
  The ID of the process
- witRefNameForFields: string
  Work item type reference name for fields
- fieldRefName: string
  The reference name of the field
Returns Promise<void>
Implementation of IWorkItemTrackingProcessDefinitionsApi.removeFieldFromWorkItemType
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:2159

removeGroup

removeGroup(
    processId: string,
    witRefName: string,
    pageId: string,
    sectionId: string,
    groupId: string,
): Promise<void>
Removes a group from the work item form
Parameters
- processId: string
  The ID of the process
- witRefName: string
  The reference name of the work item type
- pageId: string
  The ID of the page the group is in
- sectionId: string
  The ID of the section to the group is in
- groupId: string
  The ID of the group
Returns Promise<void>
Implementation of IWorkItemTrackingProcessDefinitionsApi.removeGroup
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:705

removePage

removePage(processId: string, witRefName: string, pageId: string): Promise<void>
Removes a page from the work item form
Parameters
- processId: string
  The ID of the process
- witRefName: string
  The reference name of the work item type
- pageId: string
  The ID of the page
Returns Promise<void>
Implementation of IWorkItemTrackingProcessDefinitionsApi.removePage
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:1231

replaceBehavior

replaceBehavior(
    behaviorData: BehaviorReplaceModel,
    processId: string,
    behaviorId: string,
): Promise<BehaviorModel>
Replaces a behavior in the process.
Parameters
- behaviorData: BehaviorReplaceModel
- processId: string
  The ID of the process
- behaviorId: string
  The ID of the behavior
Returns Promise<BehaviorModel>
Implementation of IWorkItemTrackingProcessDefinitionsApi.replaceBehavior
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:254

setControlInGroup

setControlInGroup(
    control: Control,
    processId: string,
    witRefName: string,
    groupId: string,
    controlId: string,
    removeFromGroupId?: string,
): Promise<Control>
Moves a control to a new group
Parameters
- control: Control
  The control
- processId: string
  The ID of the process
- witRefName: string
  The reference name of the work item type
- groupId: string
  The ID of the group to move the control to
- controlId: string
  The id of the control
- OptionalremoveFromGroupId: string
  The group to remove the control from
Returns Promise<Control>
Implementation of IWorkItemTrackingProcessDefinitionsApi.setControlInGroup
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:454

setGroupInPage

setGroupInPage(
    group: Group,
    processId: string,
    witRefName: string,
    pageId: string,
    sectionId: string,
    groupId: string,
    removeFromPageId: string,
    removeFromSectionId: string,
): Promise<Group>
Moves a group to a different page and section
Parameters
- group: Group
  The updated group
- processId: string
  The ID of the process
- witRefName: string
  The reference name of the work item type
- pageId: string
  The ID of the page the group is in
- sectionId: string
  The ID of the section the group is in
- groupId: string
  The ID of the group
- removeFromPageId: string
  ID of the page to remove the group from
- removeFromSectionId: string
  ID of the section to remove the group from
Returns Promise<Group>
Implementation of IWorkItemTrackingProcessDefinitionsApi.setGroupInPage
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:761

setGroupInSection

setGroupInSection(
    group: Group,
    processId: string,
    witRefName: string,
    pageId: string,
    sectionId: string,
    groupId: string,
    removeFromSectionId: string,
): Promise<Group>
Moves a group to a different section
Parameters
- group: Group
  The updated group
- processId: string
  The ID of the process
- witRefName: string
  The reference name of the work item type
- pageId: string
  The ID of the page the group is in
- sectionId: string
  The ID of the section the group is in
- groupId: string
  The ID of the group
- removeFromSectionId: string
  ID of the section to remove the group from
Returns Promise<Group>
Implementation of IWorkItemTrackingProcessDefinitionsApi.setGroupInSection
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:831

updateBehaviorToWorkItemType

updateBehaviorToWorkItemType(
    behavior: WorkItemTypeBehavior,
    processId: string,
    witRefNameForBehaviors: string,
): Promise<WorkItemTypeBehavior>
Updates default work item type for the behavior of the process.
Parameters
- behavior: WorkItemTypeBehavior
- processId: string
  The ID of the process
- witRefNameForBehaviors: string
  Work item type reference name for the behavior
Returns Promise<WorkItemTypeBehavior>
Implementation of IWorkItemTrackingProcessDefinitionsApi.updateBehaviorToWorkItemType
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:1744

updateField

updateField(field: FieldUpdate, processId: string): Promise<FieldModel>
Updates a given field in the process.
Parameters
- field: FieldUpdate
- processId: string
  The ID of the process
Returns Promise<FieldModel>
Implementation of IWorkItemTrackingProcessDefinitionsApi.updateField
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:552

updateList

updateList(picklist: PickListModel, listId: string): Promise<PickListModel>
Updates a list.
Parameters
- picklist: PickListModel
- listId: string
  The ID of the list
Returns Promise<PickListModel>
Implementation of IWorkItemTrackingProcessDefinitionsApi.updateList
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:1095

updateStateDefinition

updateStateDefinition(
    stateModel: WorkItemStateInputModel,
    processId: string,
    witRefName: string,
    stateId: string,
): Promise<WorkItemStateResultModel>
Updates a given state definition in the work item type of the process.
Parameters
- stateModel: WorkItemStateInputModel
- processId: string
  ID of the process
- witRefName: string
  The reference name of the work item type
- stateId: string
  ID of the state
Returns Promise<WorkItemStateResultModel>
Implementation of IWorkItemTrackingProcessDefinitionsApi.updateStateDefinition
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:1512

updateWorkItemType

updateWorkItemType(
    workItemTypeUpdate: WorkItemTypeUpdateModel,
    processId: string,
    witRefName: string,
): Promise<WorkItemTypeModel>
Updates a work item type of the process.
Parameters
- workItemTypeUpdate: WorkItemTypeUpdateModel
- processId: string
  The ID of the process
- witRefName: string
  The reference name of the work item type
Returns Promise<WorkItemTypeModel>
Implementation of IWorkItemTrackingProcessDefinitionsApi.updateWorkItemType
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:1976

updateWorkItemTypeField

updateWorkItemTypeField(
    field: WorkItemTypeFieldModel2,
    processId: string,
    witRefNameForFields: string,
): Promise<WorkItemTypeFieldModel2>
Updates a single field in the scope of the given process and work item type.
Parameters
- field: WorkItemTypeFieldModel2
  The model with which to update the field
- processId: string
  The ID of the process
- witRefNameForFields: string
  Work item type reference name for fields
Returns Promise<WorkItemTypeFieldModel2>
Implementation of IWorkItemTrackingProcessDefinitionsApi.updateWorkItemTypeField
- Defined in repos/azure-devops-node-api/api/WorkItemTrackingProcessDefinitionsApi.ts:2206

Class WorkItemTrackingProcessDefinitionsApi

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WorkItemTrackingProcessDefinitionsApi

Properties

baseUrl

http

rest

userAgent

vsoClient

Static ReadonlyRESOURCE_AREA_ID

Methods

addBehaviorToWorkItemType

Parameters

Returns Promise<WorkItemTypeBehavior>

addControlToGroup

Parameters

Returns Promise<Control>

addFieldToWorkItemType

Parameters

Returns Promise<WorkItemTypeFieldModel2>

addGroup

Parameters

Returns Promise<Group>

addPage

Parameters

Returns Promise<Page>

createAcceptHeader

Parameters

Returns string

createBehavior

Parameters

Returns Promise<BehaviorModel>

createField

Parameters

Returns Promise<FieldModel>

createList

Parameters

Returns Promise<PickListModel>

createRequestOptions

Parameters

Returns IRequestOptions

createStateDefinition

Parameters

Returns Promise<WorkItemStateResultModel>

createWorkItemType

Parameters

Returns Promise<WorkItemTypeModel>

deleteBehavior

Parameters

Returns Promise<void>

deleteList

Parameters

Returns Promise<void>

deleteStateDefinition

Parameters

Returns Promise<void>

deleteWorkItemType

Parameters

Returns Promise<void>

editControl

Parameters

Returns Promise<Control>

editGroup

Parameters

Returns Promise<Group>

editPage

Parameters

Returns Promise<Page>

formatResponse

Parameters

Returns any

getBehavior

`Static` `Readonly`RESOURCE_AREA_ID