Class WorkItemTrackingProcessApi

constructor

• new WorkItemTrackingProcessApi(
      baseUrl: string,
      handlers: IRequestHandler[],
      options?: IRequestOptions,
  ): WorkItemTrackingProcessApi

  Parameters

  • baseUrl: string
  • handlers: IRequestHandler[]
  • Optionaloptions: IRequestOptions

  Returns WorkItemTrackingProcessApi

Static ReadonlyRESOURCE_AREA_ID

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>

addFieldToWorkItemType

• addFieldToWorkItemType(
      field: AddProcessWorkItemTypeFieldRequest,
      processId: string,
      witRefName: string,
  ): Promise<ProcessWorkItemTypeField>

  Adds a field to a work item type.

  Parameters

  • field: AddProcessWorkItemTypeFieldRequest
  • processId: string

    The ID of the process.
  • witRefName: string

    The reference name of the work item type.

  Returns Promise<ProcessWorkItemTypeField>

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>

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>

addProcessWorkItemTypeRule

• addProcessWorkItemTypeRule(
      processRuleCreate: CreateProcessRuleRequest,
      processId: string,
      witRefName: string,
  ): Promise<ProcessRule>

  Adds a rule to work item type in the process.

  Parameters

  • processRuleCreate: CreateProcessRuleRequest
  • processId: string

    The ID of the process
  • witRefName: string

    The reference name of the work item type

  Returns Promise<ProcessRule>

createControlInGroup

• createControlInGroup(
      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>

createList

• createList(picklist: PickList): Promise<PickList>

  Creates a picklist.

  Parameters

  • picklist: PickList

    Picklist

  Returns Promise<PickList>

createNewProcess

• createNewProcess(createRequest: CreateProcessModel): Promise<ProcessInfo>

  Creates a process.

  Parameters

  • createRequest: CreateProcessModel

    CreateProcessModel.

  Returns Promise<ProcessInfo>

createProcessBehavior

• createProcessBehavior(
      behavior: ProcessBehaviorCreateRequest,
      processId: string,
  ): Promise<ProcessBehavior>

  Creates a single behavior in the given process.

  Parameters

  • behavior: ProcessBehaviorCreateRequest
  • processId: string

    The ID of the process

  Returns Promise<ProcessBehavior>

createProcessWorkItemType

• createProcessWorkItemType(
      workItemType: CreateProcessWorkItemTypeRequest,
      processId: string,
  ): Promise<ProcessWorkItemType>

  Creates a work item type in the process.

  Parameters

  • workItemType: CreateProcessWorkItemTypeRequest
  • processId: string

    The ID of the process on which to create work item type.

  Returns Promise<ProcessWorkItemType>

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>

deleteList

• deleteList(listId: string): Promise<void>

  Removes a picklist.

  Parameters

  • listId: string

    The ID of the list

  Returns Promise<void>

deleteProcessBehavior

• deleteProcessBehavior(processId: string, behaviorRefName: string): Promise<void>

  Removes a behavior in the process.

  Parameters

  • processId: string

    The ID of the process
  • behaviorRefName: string

    The reference name of the behavior

  Returns Promise<void>

deleteProcessById

• deleteProcessById(processTypeId: string): Promise<void>

  Removes a process of a specific ID.

  Parameters

  • processTypeId: string

  Returns Promise<void>

deleteProcessWorkItemType

• deleteProcessWorkItemType(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>

deleteProcessWorkItemTypeRule

• deleteProcessWorkItemTypeRule(
      processId: string,
      witRefName: string,
      ruleId: string,
  ): Promise<void>

  Removes a rule from the work item type in the process.

  Parameters

  • processId: string

    The ID of the process
  • witRefName: string

    The reference name of the work item type
  • ruleId: string

    The ID of the rule

  Returns Promise<void>

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>

deleteSystemControl

• deleteSystemControl(
      processId: string,
      witRefName: string,
      controlId: string,
  ): Promise<Control[]>

  Deletes a system control modification on the work item form.

  Parameters

  • processId: string

    The ID of the process.
  • witRefName: string

    The reference name of the work item type.
  • controlId: string

    The ID of the control.

  Returns Promise<Control[]>

editProcess

• editProcess(
      updateRequest: UpdateProcessModel,
      processTypeId: string,
  ): Promise<ProcessInfo>

  Edit a process of a specific ID.

  Parameters

  • updateRequest: UpdateProcessModel
  • processTypeId: string

  Returns Promise<ProcessInfo>

getAllWorkItemTypeFields

• getAllWorkItemTypeFields(
      processId: string,
      witRefName: string,
  ): Promise<ProcessWorkItemTypeField[]>

  Returns a list of all fields in a work item type.

  Parameters

  • processId: string

    The ID of the process.
  • witRefName: string

    The reference name of the work item type.

  Returns Promise<ProcessWorkItemTypeField[]>

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>

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[]>

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>

getList

• getList(listId: string): Promise<PickList>

  Returns a picklist.

  Parameters

  • listId: string

    The ID of the list

  Returns Promise<PickList>

getListOfProcesses

• getListOfProcesses(expand?: GetProcessExpandLevel): Promise<ProcessInfo[]>

  Get list of all processes including system and inherited.

  Parameters

  • Optionalexpand: GetProcessExpandLevel

  Returns Promise<ProcessInfo[]>

getListsMetadata

• getListsMetadata(): Promise<PickListMetadata[]>

  Returns meta data of the picklist.

  Returns Promise<PickListMetadata[]>

getProcessBehavior

• getProcessBehavior(
      processId: string,
      behaviorRefName: string,
      expand?: GetBehaviorsExpand,
  ): Promise<ProcessBehavior>

  Returns a behavior of the process.

  Parameters

  • processId: string

    The ID of the process
  • behaviorRefName: string

    The reference name of the behavior
  • Optionalexpand: GetBehaviorsExpand

  Returns Promise<ProcessBehavior>

getProcessBehaviors

• getProcessBehaviors(
      processId: string,
      expand?: GetBehaviorsExpand,
  ): Promise<ProcessBehavior[]>

  Returns a list of all behaviors in the process.

  Parameters

  • processId: string

    The ID of the process
  • Optionalexpand: GetBehaviorsExpand

  Returns Promise<ProcessBehavior[]>

getProcessByItsId

• getProcessByItsId(
      processTypeId: string,
      expand?: GetProcessExpandLevel,
  ): Promise<ProcessInfo>

  Get a single process of a specified ID.

  Parameters

  • processTypeId: string
  • Optionalexpand: GetProcessExpandLevel

  Returns Promise<ProcessInfo>

getProcessWorkItemType

• getProcessWorkItemType(
      processId: string,
      witRefName: string,
      expand?: GetWorkItemTypeExpand,
  ): Promise<ProcessWorkItemType>

  Returns a single work item type in a process.

  Parameters

  • processId: string

    The ID of the process
  • witRefName: string

    The reference name of the work item type
  • Optionalexpand: GetWorkItemTypeExpand

    Flag to determine what properties of work item type to return

  Returns Promise<ProcessWorkItemType>

getProcessWorkItemTypeRule

• getProcessWorkItemTypeRule(
      processId: string,
      witRefName: string,
      ruleId: string,
  ): Promise<ProcessRule>

  Returns a single rule 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
  • ruleId: string

    The ID of the rule

  Returns Promise<ProcessRule>

getProcessWorkItemTypeRules

• getProcessWorkItemTypeRules(
      processId: string,
      witRefName: string,
  ): Promise<ProcessRule[]>

  Returns a list of all rules 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<ProcessRule[]>

getProcessWorkItemTypes

• getProcessWorkItemTypes(
      processId: string,
      expand?: GetWorkItemTypeExpand,
  ): Promise<ProcessWorkItemType[]>

  Returns a list of all work item types in a process.

  Parameters

  • processId: string

    The ID of the process
  • Optionalexpand: GetWorkItemTypeExpand

    Flag to determine what properties of work item type to return

  Returns Promise<ProcessWorkItemType[]>

getStateDefinition

• getStateDefinition(
      processId: string,
      witRefName: string,
      stateId: string,
  ): Promise<WorkItemStateResultModel>

  Returns a single state definition in 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
  • stateId: string

    The ID of the state

  Returns Promise<WorkItemStateResultModel>

getStateDefinitions

• getStateDefinitions(
      processId: string,
      witRefName: string,
  ): Promise<WorkItemStateResultModel[]>

  Returns a list of all state definitions in 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

  Returns Promise<WorkItemStateResultModel[]>

getSystemControls

• getSystemControls(processId: string, witRefName: string): Promise<Control[]>

  Gets edited system controls for a work item type in a process. To get all system controls (base + edited) use layout API(s)

  Parameters

  • processId: string

    The ID of the process.
  • witRefName: string

    The reference name of the work item type.

  Returns Promise<Control[]>

getWorkItemTypeField

• getWorkItemTypeField(
      processId: string,
      witRefName: string,
      fieldRefName: string,
      expand?: ProcessWorkItemTypeFieldsExpandLevel,
  ): Promise<ProcessWorkItemTypeField>

  Returns a field in a work item type.

  Parameters

  • processId: string

    The ID of the process.
  • witRefName: string

    The reference name of the work item type.
  • fieldRefName: string

    The reference name of the field.
  • Optionalexpand: ProcessWorkItemTypeFieldsExpandLevel

  Returns Promise<ProcessWorkItemTypeField>

hideStateDefinition

• hideStateDefinition(
      hideStateModel: HideStateModel,
      processId: string,
      witRefName: string,
      stateId: string,
  ): Promise<WorkItemStateResultModel>

  Hides a state definition in the work item type of the process.Only states with customizationType:System can be hidden.

  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>

moveControlToGroup

• moveControlToGroup(
      control: Control,
      processId: string,
      witRefName: string,
      groupId: string,
      controlId: string,
      removeFromGroupId?: string,
  ): Promise<Control>

  Moves a control to a specified 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 ID to remove the control from.

  Returns Promise<Control>

moveGroupToPage

• moveGroupToPage(
      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 i.n
  • 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>

moveGroupToSection

• moveGroupToSection(
      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>

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>

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>

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>

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>

removeWorkItemTypeField

• removeWorkItemTypeField(
      processId: string,
      witRefName: string,
      fieldRefName: string,
  ): Promise<void>

  Removes a field from a work item type. Does not permanently delete the field.

  Parameters

  • processId: string

    The ID of the process.
  • witRefName: string

    The reference name of the work item type.
  • fieldRefName: string

    The reference name of the field.

  Returns Promise<void>

updateBehaviorToWorkItemType

• updateBehaviorToWorkItemType(
      behavior: WorkItemTypeBehavior,
      processId: string,
      witRefNameForBehaviors: string,
  ): Promise<WorkItemTypeBehavior>

  Updates a behavior for 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>

updateControl

• updateControl(
      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>

updateGroup

• updateGroup(
      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>

updateList

• updateList(picklist: PickList, listId: string): Promise<PickList>

  Updates a list.

  Parameters

  • picklist: PickList
  • listId: string

    The ID of the list

  Returns Promise<PickList>

updatePage

• updatePage(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>

updateProcessBehavior

• updateProcessBehavior(
      behaviorData: ProcessBehaviorUpdateRequest,
      processId: string,
      behaviorRefName: string,
  ): Promise<ProcessBehavior>

  Replaces a behavior in the process.

  Parameters

  • behaviorData: ProcessBehaviorUpdateRequest
  • processId: string

    The ID of the process
  • behaviorRefName: string

    The reference name of the behavior

  Returns Promise<ProcessBehavior>

updateProcessWorkItemType

• updateProcessWorkItemType(
      workItemTypeUpdate: UpdateProcessWorkItemTypeRequest,
      processId: string,
      witRefName: string,
  ): Promise<ProcessWorkItemType>

  Updates a work item type of the process.

  Parameters

  • workItemTypeUpdate: UpdateProcessWorkItemTypeRequest
  • processId: string

    The ID of the process
  • witRefName: string

    The reference name of the work item type

  Returns Promise<ProcessWorkItemType>

updateProcessWorkItemTypeRule

• updateProcessWorkItemTypeRule(
      processRule: UpdateProcessRuleRequest,
      processId: string,
      witRefName: string,
      ruleId: string,
  ): Promise<ProcessRule>

  Updates a rule in the work item type of the process.

  Parameters

  • processRule: UpdateProcessRuleRequest
  • processId: string

    The ID of the process
  • witRefName: string

    The reference name of the work item type
  • ruleId: string

    The ID of the rule

  Returns Promise<ProcessRule>

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>

updateSystemControl

• updateSystemControl(
      control: Control,
      processId: string,
      witRefName: string,
      controlId: string,
  ): Promise<Control>

  Updates/adds a system control on the work item form.

  Parameters

  • control: Control
  • processId: string

    The ID of the process.
  • witRefName: string

    The reference name of the work item type.
  • controlId: string

    The ID of the control.

  Returns Promise<Control>

updateWorkItemTypeField

• updateWorkItemTypeField(
      field: UpdateProcessWorkItemTypeFieldRequest,
      processId: string,
      witRefName: string,
      fieldRefName: string,
  ): Promise<ProcessWorkItemTypeField>

  Updates a field in a work item type.

  Parameters

  • field: UpdateProcessWorkItemTypeFieldRequest
  • processId: string

    The ID of the process.
  • witRefName: string

    The reference name of the work item type.
  • fieldRefName: string

    The reference name of the field.

  Returns Promise<ProcessWorkItemTypeField>