WorkItemTrackingProcessRestClient class
Base class that should be used (derived from) to make requests to VSS REST apis
- Extends
Constructors
| Work |
Properties
| RESOURCE_AREA_ID |
Methods
Constructor Details
WorkItemTrackingProcessRestClient(IVssRestClientOptions)
new WorkItemTrackingProcessRestClient(options: IVssRestClientOptions)Parameters
- options
- IVssRestClientOptions
Property Details
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringProperty Value
string
Method Details
addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)
Adds a behavior to the work item type of the process.
function addBehaviorToWorkItemType(behavior: WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior>Parameters
- behavior
- WorkItemTypeBehavior
- processId
-
string
The ID of the process
- witRefNameForBehaviors
-
string
Work item type reference name for the behavior
Returns
Promise<WorkItemTypeBehavior>
addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)
Adds a field to a work item type.
function addFieldToWorkItemType(field: AddProcessWorkItemTypeFieldRequest, processId: string, witRefName: string): Promise<ProcessWorkItemTypeField>Parameters
- processId
-
string
The ID of the process.
- witRefName
-
string
The reference name of the work item type.
Returns
Promise<ProcessWorkItemTypeField>
addGroup(Group, string, string, string, string)
Adds a group to the work item form.
function addGroup(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string): Promise<Group>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(Page, string, string)
Adds a page to the work item form.
function addPage(page: Page, processId: string, witRefName: string): Promise<Page>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(CreateProcessRuleRequest, string, string)
Adds a rule to work item type in the process.
function addProcessWorkItemTypeRule(processRuleCreate: CreateProcessRuleRequest, processId: string, witRefName: string): Promise<ProcessRule>Parameters
- processRuleCreate
- CreateProcessRuleRequest
- processId
-
string
The ID of the process
- witRefName
-
string
The reference name of the work item type
Returns
Promise<ProcessRule>
createControlInGroup(Control, string, string, string)
Creates a control in a group.
function createControlInGroup(control: Control, processId: string, witRefName: string, groupId: string): Promise<Control>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(PickList)
Creates a picklist.
function createList(picklist: PickList): Promise<PickList>Parameters
- picklist
- PickList
Picklist
Returns
Promise<PickList>
createNewProcess(CreateProcessModel)
Creates a process.
function createNewProcess(createRequest: CreateProcessModel): Promise<ProcessInfo>Parameters
- createRequest
- CreateProcessModel
CreateProcessModel.
Returns
Promise<ProcessInfo>
createProcessBehavior(ProcessBehaviorCreateRequest, string)
Creates a single behavior in the given process.
function createProcessBehavior(behavior: ProcessBehaviorCreateRequest, processId: string): Promise<ProcessBehavior>Parameters
- behavior
- ProcessBehaviorCreateRequest
- processId
-
string
The ID of the process
Returns
Promise<ProcessBehavior>
createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)
Creates a work item type in the process.
function createProcessWorkItemType(workItemType: CreateProcessWorkItemTypeRequest, processId: string): Promise<ProcessWorkItemType>Parameters
- workItemType
- CreateProcessWorkItemTypeRequest
- processId
-
string
The ID of the process on which to create work item type.
Returns
Promise<ProcessWorkItemType>
createStateDefinition(WorkItemStateInputModel, string, string)
Creates a state definition in the work item type of the process.
function createStateDefinition(stateModel: WorkItemStateInputModel, processId: string, witRefName: string): Promise<WorkItemStateResultModel>Parameters
- stateModel
- WorkItemStateInputModel
- processId
-
string
The ID of the process
- witRefName
-
string
The reference name of the work item type
Returns
Promise<WorkItemStateResultModel>
deleteList(string)
Removes a picklist.
function deleteList(listId: string): Promise<void>Parameters
- listId
-
string
The ID of the list
Returns
Promise<void>
deleteProcessBehavior(string, string)
Removes a behavior in the process.
function deleteProcessBehavior(processId: string, behaviorRefName: string): Promise<void>Parameters
- processId
-
string
The ID of the process
- behaviorRefName
-
string
The reference name of the behavior
Returns
Promise<void>
deleteProcessById(string)
Removes a process of a specific ID.
function deleteProcessById(processTypeId: string): Promise<void>Parameters
- processTypeId
-
string
Returns
Promise<void>
deleteProcessWorkItemType(string, string)
Removes a work item type in the process.
function deleteProcessWorkItemType(processId: string, witRefName: string): Promise<void>Parameters
- processId
-
string
The ID of the process.
- witRefName
-
string
The reference name of the work item type.
Returns
Promise<void>
deleteProcessWorkItemTypeRule(string, string, string)
Removes a rule from the work item type in the process.
function deleteProcessWorkItemTypeRule(processId: string, witRefName: string, ruleId: string): Promise<void>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(string, string, string)
Removes a state definition in the work item type of the process.
function deleteStateDefinition(processId: string, witRefName: string, stateId: string): Promise<void>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(string, string, string)
Deletes a system control modification on the work item form.
function deleteSystemControl(processId: string, witRefName: string, controlId: string): Promise<Control[]>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(UpdateProcessModel, string)
Edit a process of a specific ID.
function editProcess(updateRequest: UpdateProcessModel, processTypeId: string): Promise<ProcessInfo>Parameters
- updateRequest
- UpdateProcessModel
- processTypeId
-
string
Returns
Promise<ProcessInfo>
getAllWorkItemTypeFields(string, string)
Returns a list of all fields in a work item type.
function getAllWorkItemTypeFields(processId: string, witRefName: string): Promise<ProcessWorkItemTypeField[]>Parameters
- processId
-
string
The ID of the process.
- witRefName
-
string
The reference name of the work item type.
Returns
Promise<ProcessWorkItemTypeField[]>
getBehaviorForWorkItemType(string, string, string)
Returns a behavior for the work item type of the process.
function getBehaviorForWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<WorkItemTypeBehavior>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(string, string)
Returns a list of all behaviors for the work item type of the process.
function getBehaviorsForWorkItemType(processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior[]>Parameters
- processId
-
string
The ID of the process
- witRefNameForBehaviors
-
string
Work item type reference name for the behavior
Returns
Promise<WorkItemTypeBehavior[]>
getFormLayout(string, string)
Gets the form layout.
function getFormLayout(processId: string, witRefName: string): Promise<FormLayout>Parameters
- processId
-
string
The ID of the process.
- witRefName
-
string
The reference name of the work item type.
Returns
Promise<FormLayout>
getList(string)
Returns a picklist.
function getList(listId: string): Promise<PickList>Parameters
- listId
-
string
The ID of the list
Returns
Promise<PickList>
getListOfProcesses(GetProcessExpandLevel)
Get list of all processes including system and inherited.
function getListOfProcesses(expand?: GetProcessExpandLevel): Promise<ProcessInfo[]>Parameters
- expand
- GetProcessExpandLevel
Returns
Promise<ProcessInfo[]>
getListsMetadata()
Returns meta data of the picklist.
function getListsMetadata(): Promise<PickListMetadata[]>Returns
Promise<PickListMetadata[]>
getProcessBehavior(string, string, GetBehaviorsExpand)
Returns a behavior of the process.
function getProcessBehavior(processId: string, behaviorRefName: string, expand?: GetBehaviorsExpand): Promise<ProcessBehavior>Parameters
- processId
-
string
The ID of the process
- behaviorRefName
-
string
The reference name of the behavior
- expand
- GetBehaviorsExpand
Returns
Promise<ProcessBehavior>
getProcessBehaviors(string, GetBehaviorsExpand)
Returns a list of all behaviors in the process.
function getProcessBehaviors(processId: string, expand?: GetBehaviorsExpand): Promise<ProcessBehavior[]>Parameters
- processId
-
string
The ID of the process
- expand
- GetBehaviorsExpand
Returns
Promise<ProcessBehavior[]>
getProcessByItsId(string, GetProcessExpandLevel)
Get a single process of a specified ID.
function getProcessByItsId(processTypeId: string, expand?: GetProcessExpandLevel): Promise<ProcessInfo>Parameters
- processTypeId
-
string
- expand
- GetProcessExpandLevel
Returns
Promise<ProcessInfo>
getProcessWorkItemType(string, string, GetWorkItemTypeExpand)
Returns a single work item type in a process.
function getProcessWorkItemType(processId: string, witRefName: string, expand?: GetWorkItemTypeExpand): Promise<ProcessWorkItemType>Parameters
- processId
-
string
The ID of the process
- witRefName
-
string
The reference name of the work item type
- expand
- GetWorkItemTypeExpand
Flag to determine what properties of work item type to return
Returns
Promise<ProcessWorkItemType>
getProcessWorkItemTypeRule(string, string, string)
Returns a single rule in the work item type of the process.
function getProcessWorkItemTypeRule(processId: string, witRefName: string, ruleId: string): Promise<ProcessRule>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(string, string)
Returns a list of all rules in the work item type of the process.
function getProcessWorkItemTypeRules(processId: string, witRefName: string): Promise<ProcessRule[]>Parameters
- processId
-
string
The ID of the process
- witRefName
-
string
The reference name of the work item type
Returns
Promise<ProcessRule[]>
getProcessWorkItemTypes(string, GetWorkItemTypeExpand)
Returns a list of all work item types in a process.
function getProcessWorkItemTypes(processId: string, expand?: GetWorkItemTypeExpand): Promise<ProcessWorkItemType[]>Parameters
- processId
-
string
The ID of the process
- expand
- GetWorkItemTypeExpand
Flag to determine what properties of work item type to return
Returns
Promise<ProcessWorkItemType[]>
getStateDefinition(string, string, string)
Returns a single state definition in a work item type of the process.
function getStateDefinition(processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>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(string, string)
Returns a list of all state definitions in a work item type of the process.
function getStateDefinitions(processId: string, witRefName: string): Promise<WorkItemStateResultModel[]>Parameters
- processId
-
string
The ID of the process
- witRefName
-
string
The reference name of the work item type
Returns
Promise<WorkItemStateResultModel[]>
getSystemControls(string, string)
Gets edited system controls for a work item type in a process. To get all system controls (base + edited) use layout API(s)
function getSystemControls(processId: string, witRefName: string): Promise<Control[]>Parameters
- processId
-
string
The ID of the process.
- witRefName
-
string
The reference name of the work item type.
Returns
Promise<Control[]>
getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)
Returns a field in a work item type.
function getWorkItemTypeField(processId: string, witRefName: string, fieldRefName: string, expand?: ProcessWorkItemTypeFieldsExpandLevel): Promise<ProcessWorkItemTypeField>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<ProcessWorkItemTypeField>
hideStateDefinition(HideStateModel, string, string, string)
Hides a state definition in the work item type of the process.Only states with customizationType:System can be hidden.
function hideStateDefinition(hideStateModel: HideStateModel, processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>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(Control, string, string, string, string, string)
Moves a control to a specified group.
function moveControlToGroup(control: Control, processId: string, witRefName: string, groupId: string, controlId: string, removeFromGroupId?: string): Promise<Control>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.
- removeFromGroupId
-
string
The group ID to remove the control from.
Returns
Promise<Control>
moveGroupToPage(Group, string, string, string, string, string, string, string)
Moves a group to a different page and section.
function moveGroupToPage(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromPageId: string, removeFromSectionId: string): Promise<Group>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(Group, string, string, string, string, string, string)
Moves a group to a different section.
function moveGroupToSection(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromSectionId: string): Promise<Group>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(string, string, string)
Removes a behavior for the work item type of the process.
function removeBehaviorFromWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<void>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(string, string, string, string)
Removes a control from the work item form.
function removeControlFromGroup(processId: string, witRefName: string, groupId: string, controlId: string): Promise<void>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(string, string, string, string, string)
Removes a group from the work item form.
function removeGroup(processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise<void>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(string, string, string)
Removes a page from the work item form
function removePage(processId: string, witRefName: string, pageId: string): Promise<void>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(string, string, string)
Removes a field from a work item type. Does not permanently delete the field.
function removeWorkItemTypeField(processId: string, witRefName: string, fieldRefName: string): Promise<void>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(WorkItemTypeBehavior, string, string)
Updates a behavior for the work item type of the process.
function updateBehaviorToWorkItemType(behavior: WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior>Parameters
- behavior
- WorkItemTypeBehavior
- processId
-
string
The ID of the process
- witRefNameForBehaviors
-
string
Work item type reference name for the behavior
Returns
Promise<WorkItemTypeBehavior>
updateControl(Control, string, string, string, string)
Updates a control on the work item form.
function updateControl(control: Control, processId: string, witRefName: string, groupId: string, controlId: string): Promise<Control>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(Group, string, string, string, string, string)
Updates a group in the work item form.
function updateGroup(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise<Group>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(PickList, string)
Updates a list.
function updateList(picklist: PickList, listId: string): Promise<PickList>Parameters
- picklist
- PickList
- listId
-
string
The ID of the list
Returns
Promise<PickList>
updatePage(Page, string, string)
Updates a page on the work item form
function updatePage(page: Page, processId: string, witRefName: string): Promise<Page>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(ProcessBehaviorUpdateRequest, string, string)
Replaces a behavior in the process.
function updateProcessBehavior(behaviorData: ProcessBehaviorUpdateRequest, processId: string, behaviorRefName: string): Promise<ProcessBehavior>Parameters
- behaviorData
- ProcessBehaviorUpdateRequest
- processId
-
string
The ID of the process
- behaviorRefName
-
string
The reference name of the behavior
Returns
Promise<ProcessBehavior>
updateProcessWorkItemType(UpdateProcessWorkItemTypeRequest, string, string)
Updates a work item type of the process.
function updateProcessWorkItemType(workItemTypeUpdate: UpdateProcessWorkItemTypeRequest, processId: string, witRefName: string): Promise<ProcessWorkItemType>Parameters
- workItemTypeUpdate
- UpdateProcessWorkItemTypeRequest
- processId
-
string
The ID of the process
- witRefName
-
string
The reference name of the work item type
Returns
Promise<ProcessWorkItemType>
updateProcessWorkItemTypeRule(UpdateProcessRuleRequest, string, string, string)
Updates a rule in the work item type of the process.
function updateProcessWorkItemTypeRule(processRule: UpdateProcessRuleRequest, processId: string, witRefName: string, ruleId: string): Promise<ProcessRule>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(WorkItemStateInputModel, string, string, string)
Updates a given state definition in the work item type of the process.
function updateStateDefinition(stateModel: WorkItemStateInputModel, processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>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(Control, string, string, string)
Updates/adds a system control on the work item form.
function updateSystemControl(control: Control, processId: string, witRefName: string, controlId: string): Promise<Control>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(UpdateProcessWorkItemTypeFieldRequest, string, string, string)
Updates a field in a work item type.
function updateWorkItemTypeField(field: UpdateProcessWorkItemTypeFieldRequest, processId: string, witRefName: string, fieldRefName: string): Promise<ProcessWorkItemTypeField>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<ProcessWorkItemTypeField>
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for