WorkItemTrackingProcessRestClient class

Pakket:

azure-devops-extension-api

Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen voor VSS REST API's

Extends

RestClientBase

Constructors

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

Eigenschappen

RESOURCE_AREA_ID

Methoden

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Hiermee voegt u een gedrag toe aan het type werkitem van het proces.
addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)	Hiermee voegt u een veld toe aan een type werkitem.
addGroup(Group, string, string, string, string)	Hiermee voegt u een groep toe aan het werkitemformulier.
addPage(Page, string, string)	Hiermee voegt u een pagina toe aan het werkitemformulier.
addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)	Hiermee voegt u een regel toe aan het type werkitem in het proces.
createControlInGroup(Control, string, string, string)	Hiermee maakt u een besturingselement in een groep.
createList(PickList)	Hiermee maakt u een selectielijst.
createNewProcess(CreateProcessModel)	Hiermee maakt u een proces.
createProcessBehavior(ProcessBehaviorCreateRequest, string)	Hiermee maakt u één gedrag in het opgegeven proces.
createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)	Hiermee maakt u een type werkitem in het proces.
createStateDefinition(WorkItemStateInputModel, string, string)	Hiermee maakt u een statusdefinitie in het type werkitem van het proces.
deleteList(string)	Hiermee verwijdert u een selectielijst.
deleteProcessBehavior(string, string)	Hiermee verwijdert u een gedrag in het proces.
deleteProcessById(string)	Hiermee verwijdert u een proces van een specifieke id.
deleteProcessWorkItemType(string, string)	Hiermee verwijdert u een type werkitem in het proces.
deleteProcessWorkItemTypeRule(string, string, string)	Hiermee verwijdert u een regel uit het type werkitem in het proces.
deleteStateDefinition(string, string, string)	Hiermee verwijdert u een statusdefinitie in het type werkitem van het proces.
deleteSystemControl(string, string, string)	Hiermee verwijdert u een wijziging van het systeembesturingselement in het werkitemformulier.
editProcess(UpdateProcessModel, string)	Een proces van een specifieke id bewerken.
getAllWorkItemTypeFields(string, string)	Retourneert een lijst met alle velden in een type werkitem.
getBehaviorForWorkItemType(string, string, string)	Retourneert een gedrag voor het type werkitem van het proces.
getBehaviorsForWorkItemType(string, string)	Retourneert een lijst met alle gedragingen voor het type werkitem van het proces.
getFormLayout(string, string)	Hiermee haalt u de formulierindeling op.
getList(string)	Retourneert een selectielijst.
getListOfProcesses(GetProcessExpandLevel)	Haal een lijst op met alle processen, inclusief systeem en overgenomen processen.
getListsMetadata()	Hiermee worden metagegevens van de selectielijst geretourneerd.
getProcessBehavior(string, string, GetBehaviorsExpand)	Retourneert een gedrag van het proces.
getProcessBehaviors(string, GetBehaviorsExpand)	Retourneert een lijst met alle gedragingen in het proces.
getProcessByItsId(string, GetProcessExpandLevel)	Haal één proces van een opgegeven id op.
getProcessWorkItemType(string, string, GetWorkItemTypeExpand)	Retourneert één type werkitem in een proces.
getProcessWorkItemTypeRule(string, string, string)	Retourneert één regel in het type werkitem van het proces.
getProcessWorkItemTypeRules(string, string)	Retourneert een lijst met alle regels in het type werkitem van het proces.
getProcessWorkItemTypes(string, GetWorkItemTypeExpand)	Retourneert een lijst met alle typen werkitems in een proces.
getStateDefinition(string, string, string)	Retourneert één statusdefinitie in een werkitemtype van het proces.
getStateDefinitions(string, string)	Retourneert een lijst met alle statusdefinities in een werkitemtype van het proces.
getSystemControls(string, string)	Hiermee haalt u bewerkte systeembesturingselementen op voor een type werkitem in een proces. Als u alle systeembesturingselementen (basis + bewerkt) wilt ophalen, gebruikt u indelings-API('s)
getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)	Retourneert een veld in een type werkitem.
hideStateDefinition(HideStateModel, string, string, string)	Hiermee verbergt u een statusdefinitie in het type werkitem van het proces. Alleen statussen met customizationType:System kunnen worden verborgen.
moveControlToGroup(Control, string, string, string, string, string)	Hiermee verplaatst u een besturingselement naar een opgegeven groep.
moveGroupToPage(Group, string, string, string, string, string, string, string)	Hiermee verplaatst u een groep naar een andere pagina en sectie.
moveGroupToSection(Group, string, string, string, string, string, string)	Hiermee verplaatst u een groep naar een andere sectie.
removeBehaviorFromWorkItemType(string, string, string)	Hiermee verwijdert u een gedrag voor het type werkitem van het proces.
removeControlFromGroup(string, string, string, string)	Hiermee verwijdert u een besturingselement uit het werkitemformulier.
removeGroup(string, string, string, string, string)	Hiermee verwijdert u een groep uit het werkitemformulier.
removePage(string, string, string)	Hiermee verwijdert u een pagina uit het werkitemformulier
removeWorkItemTypeField(string, string, string)	Hiermee verwijdert u een veld uit een type werkitem. Hiermee wordt het veld niet definitief verwijderd.
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Updates een gedrag voor het type werkitem van het proces.
updateControl(Control, string, string, string, string)	Updates een besturingselement op het werkitemformulier.
updateGroup(Group, string, string, string, string, string)	Updates een groep in het werkitemformulier.
updateList(PickList, string)	Updates een lijst.
updatePage(Page, string, string)	Updates een pagina in het werkitemformulier
updateProcessBehavior(ProcessBehaviorUpdateRequest, string, string)	Vervangt een gedrag in het proces.
updateProcessWorkItemType(UpdateProcessWorkItemTypeRequest, string, string)	Updates een type werkitem van het proces.
updateProcessWorkItemTypeRule(UpdateProcessRuleRequest, string, string, string)	Updates een regel in het type werkitem van het proces.
updateStateDefinition(WorkItemStateInputModel, string, string, string)	Updates een bepaalde statusdefinitie in het type werkitem van het proces.
updateSystemControl(Control, string, string, string)	Updates/voegt een systeembesturingselement toe aan het werkitemformulier.
updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)	Updates een veld in een type werkitem.

Constructordetails

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

new WorkItemTrackingProcessRestClient(options: IVssRestClientOptions)

Parameters

options

IVssRestClientOptions

Eigenschapdetails

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Waarde van eigenschap

string

Methodedetails

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Hiermee voegt u een gedrag toe aan het type werkitem van het proces.

function addBehaviorToWorkItemType(behavior: WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior>

Parameters

behavior

WorkItemTypeBehavior

processId

string

De ID van het proces

witRefNameForBehaviors

string

Verwijzingsnaam van werkitemtype voor het gedrag

Retouren

Promise<WorkItemTypeBehavior>

addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)

Hiermee voegt u een veld toe aan een type werkitem.

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

Parameters

field

AddProcessWorkItemTypeFieldRequest

processId

string

De id van het proces.

witRefName

string

De verwijzingsnaam van het type werkitem.

Retouren

Promise<ProcessWorkItemTypeField>

addGroup(Group, string, string, string, string)

Hiermee voegt u een groep toe aan het werkitemformulier.

function addGroup(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string): Promise<Group>

Parameters

group

Group

De groep.

processId

string

De id van het proces.

witRefName

string

De verwijzingsnaam van het type werkitem.

pageId

string

De id van de pagina waaraan u de groep wilt toevoegen.

sectionId

string

De id van de sectie waaraan u de groep wilt toevoegen.

Retouren

Promise<Group>

addPage(Page, string, string)

Hiermee voegt u een pagina toe aan het werkitemformulier.

function addPage(page: Page, processId: string, witRefName: string): Promise<Page>

Parameters

page

Page

De pagina.

processId

string

De id van het proces.

witRefName

string

De verwijzingsnaam van het type werkitem.

Retouren

Promise<Page>

addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)

Hiermee voegt u een regel toe aan het type werkitem in het proces.

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

Parameters

processRuleCreate

CreateProcessRuleRequest

processId

string

De ID van het proces

witRefName

string

De verwijzingsnaam van het type werkitem

Retouren

Promise<ProcessRule>

createControlInGroup(Control, string, string, string)

Hiermee maakt u een besturingselement in een groep.

function createControlInGroup(control: Control, processId: string, witRefName: string, groupId: string): Promise<Control>

Parameters

control

Control

Het besturingselement.

processId

string

De id van het proces.

witRefName

string

De verwijzingsnaam van het type werkitem.

groupId

string

De id van de groep waaraan u het besturingselement wilt toevoegen.

Retouren

Promise<Control>

createList(PickList)

Hiermee maakt u een selectielijst.

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

Parameters

picklist

PickList

Picklist

Retouren

Promise<PickList>

createNewProcess(CreateProcessModel)

Hiermee maakt u een proces.

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

Parameters

createRequest

CreateProcessModel

CreateProcessModel.

Retouren

Promise<ProcessInfo>

createProcessBehavior(ProcessBehaviorCreateRequest, string)

Hiermee maakt u één gedrag in het opgegeven proces.

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

Parameters

behavior

ProcessBehaviorCreateRequest

processId

string

De ID van het proces

Retouren

Promise<ProcessBehavior>

createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)

Hiermee maakt u een type werkitem in het proces.

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

Parameters

workItemType

CreateProcessWorkItemTypeRequest

processId

string

De id van het proces voor het maken van het type werkitem.

Retouren

Promise<ProcessWorkItemType>

createStateDefinition(WorkItemStateInputModel, string, string)

Hiermee maakt u een statusdefinitie in het type werkitem van het proces.

function createStateDefinition(stateModel: WorkItemStateInputModel, processId: string, witRefName: string): Promise<WorkItemStateResultModel>

Parameters

stateModel

WorkItemStateInputModel

processId

string

De ID van het proces

witRefName

string

De verwijzingsnaam van het type werkitem

Retouren

Promise<WorkItemStateResultModel>

deleteList(string)

Hiermee verwijdert u een selectielijst.

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

Parameters

listId

string

De id van de lijst

Retouren

Promise<void>

deleteProcessBehavior(string, string)

Hiermee verwijdert u een gedrag in het proces.

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

Parameters

processId

string

De ID van het proces

behaviorRefName

string

De verwijzingsnaam van het gedrag

Retouren

Promise<void>

deleteProcessById(string)

Hiermee verwijdert u een proces van een specifieke id.

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

Parameters

processTypeId

string

Retouren

Promise<void>

deleteProcessWorkItemType(string, string)

Hiermee verwijdert u een type werkitem in het proces.

function deleteProcessWorkItemType(processId: string, witRefName: string): Promise<void>

Parameters

processId

string

De id van het proces.

witRefName

string

De verwijzingsnaam van het type werkitem.

Retouren

Promise<void>

deleteProcessWorkItemTypeRule(string, string, string)

Hiermee verwijdert u een regel uit het type werkitem in het proces.

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

Parameters

processId

string

De ID van het proces

witRefName

string

De verwijzingsnaam van het type werkitem

ruleId

string

De id van de regel

Retouren

Promise<void>

deleteStateDefinition(string, string, string)

Hiermee verwijdert u een statusdefinitie in het type werkitem van het proces.

function deleteStateDefinition(processId: string, witRefName: string, stateId: string): Promise<void>

Parameters

processId

string

Id van het proces

witRefName

string

De verwijzingsnaam van het type werkitem

stateId

string

Id van de status

Retouren

Promise<void>

deleteSystemControl(string, string, string)

Hiermee verwijdert u een wijziging van het systeembesturingselement in het werkitemformulier.

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

Parameters

processId

string

De id van het proces.

witRefName

string

De verwijzingsnaam van het type werkitem.

controlId

string

De id van het besturingselement.

Retouren

Promise<Control[]>

editProcess(UpdateProcessModel, string)

Een proces van een specifieke id bewerken.

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

Parameters

updateRequest

UpdateProcessModel

processTypeId

string

Retouren

Promise<ProcessInfo>

getAllWorkItemTypeFields(string, string)

Retourneert een lijst met alle velden in een type werkitem.

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

Parameters

processId

string

De id van het proces.

witRefName

string

De verwijzingsnaam van het type werkitem.

Retouren

Promise<ProcessWorkItemTypeField[]>

getBehaviorForWorkItemType(string, string, string)

Retourneert een gedrag voor het type werkitem van het proces.

function getBehaviorForWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<WorkItemTypeBehavior>

Parameters

processId

string

De ID van het proces

witRefNameForBehaviors

string

Verwijzingsnaam van werkitemtype voor het gedrag

behaviorRefName

string

De verwijzingsnaam van het gedrag

Retouren

Promise<WorkItemTypeBehavior>

getBehaviorsForWorkItemType(string, string)

Retourneert een lijst met alle gedragingen voor het type werkitem van het proces.

function getBehaviorsForWorkItemType(processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior[]>

Parameters

processId

string

De ID van het proces

witRefNameForBehaviors

string

Verwijzingsnaam van werkitemtype voor het gedrag

Retouren

Promise<WorkItemTypeBehavior[]>

getFormLayout(string, string)

Hiermee haalt u de formulierindeling op.

function getFormLayout(processId: string, witRefName: string): Promise<FormLayout>

Parameters

processId

string

De id van het proces.

witRefName

string

De verwijzingsnaam van het type werkitem.

Retouren

Promise<FormLayout>

getList(string)

Retourneert een selectielijst.

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

Parameters

listId

string

De id van de lijst

Retouren

Promise<PickList>

getListOfProcesses(GetProcessExpandLevel)

Haal een lijst op met alle processen, inclusief systeem en overgenomen processen.

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

Parameters

expand

GetProcessExpandLevel

Retouren

Promise<ProcessInfo[]>

getListsMetadata()

Hiermee worden metagegevens van de selectielijst geretourneerd.

function getListsMetadata(): Promise<PickListMetadata[]>

Retouren

Promise<PickListMetadata[]>

getProcessBehavior(string, string, GetBehaviorsExpand)

Retourneert een gedrag van het proces.

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

Parameters

processId

string

De ID van het proces

behaviorRefName

string

De verwijzingsnaam van het gedrag

expand

GetBehaviorsExpand

Retouren

Promise<ProcessBehavior>

getProcessBehaviors(string, GetBehaviorsExpand)

Retourneert een lijst met alle gedragingen in het proces.

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

Parameters

processId

string

De ID van het proces

expand

GetBehaviorsExpand

Retouren

Promise<ProcessBehavior[]>

getProcessByItsId(string, GetProcessExpandLevel)

Haal één proces van een opgegeven id op.

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

Parameters

processTypeId

string

expand

GetProcessExpandLevel

Retouren

Promise<ProcessInfo>

getProcessWorkItemType(string, string, GetWorkItemTypeExpand)

Retourneert één type werkitem in een proces.

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

Parameters

processId

string

De ID van het proces

witRefName

string

De verwijzingsnaam van het type werkitem

expand

GetWorkItemTypeExpand

Vlag om te bepalen welke eigenschappen van het type werkitem moeten worden geretourneerd

Retouren

Promise<ProcessWorkItemType>

getProcessWorkItemTypeRule(string, string, string)

Retourneert één regel in het type werkitem van het proces.

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

Parameters

processId

string

De ID van het proces

witRefName

string

De verwijzingsnaam van het type werkitem

ruleId

string

De id van de regel

Retouren

Promise<ProcessRule>

getProcessWorkItemTypeRules(string, string)

Retourneert een lijst met alle regels in het type werkitem van het proces.

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

Parameters

processId

string

De ID van het proces

witRefName

string

De verwijzingsnaam van het type werkitem

Retouren

Promise<ProcessRule[]>

getProcessWorkItemTypes(string, GetWorkItemTypeExpand)

Retourneert een lijst met alle typen werkitems in een proces.

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

Parameters

processId

string

De ID van het proces

expand

GetWorkItemTypeExpand

Vlag om te bepalen welke eigenschappen van het type werkitem moeten worden geretourneerd

Retouren

Promise<ProcessWorkItemType[]>

getStateDefinition(string, string, string)

Retourneert één statusdefinitie in een werkitemtype van het proces.

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

Parameters

processId

string

De ID van het proces

witRefName

string

De verwijzingsnaam van het type werkitem

stateId

string

De id van de status

Retouren

Promise<WorkItemStateResultModel>

getStateDefinitions(string, string)

Retourneert een lijst met alle statusdefinities in een werkitemtype van het proces.

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

Parameters

processId

string

De ID van het proces

witRefName

string

De verwijzingsnaam van het type werkitem

Retouren

Promise<WorkItemStateResultModel[]>

getSystemControls(string, string)

Hiermee haalt u bewerkte systeembesturingselementen op voor een type werkitem in een proces. Als u alle systeembesturingselementen (basis + bewerkt) wilt ophalen, gebruikt u indelings-API('s)

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

Parameters

processId

string

De id van het proces.

witRefName

string

De verwijzingsnaam van het type werkitem.

Retouren

Promise<Control[]>

getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)

Retourneert een veld in een type werkitem.

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

Parameters

processId

string

De id van het proces.

witRefName

string

De verwijzingsnaam van het type werkitem.

fieldRefName

string

De verwijzingsnaam van het veld.

expand

ProcessWorkItemTypeFieldsExpandLevel

Retouren

Promise<ProcessWorkItemTypeField>

hideStateDefinition(HideStateModel, string, string, string)

Hiermee verbergt u een statusdefinitie in het type werkitem van het proces. Alleen statussen met customizationType:System kunnen worden verborgen.

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

Parameters

hideStateModel

HideStateModel

processId

string

De ID van het proces

witRefName

string

De verwijzingsnaam van het type werkitem

stateId

string

De id van de status

Retouren

Promise<WorkItemStateResultModel>

moveControlToGroup(Control, string, string, string, string, string)

Hiermee verplaatst u een besturingselement naar een opgegeven groep.

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

Parameters

control

Control

Het besturingselement.

processId

string

De id van het proces.

witRefName

string

De verwijzingsnaam van het type werkitem.

groupId

string

De id van de groep waar het besturingselement naartoe moet worden verplaatst.

controlId

string

De id van het besturingselement.

removeFromGroupId

string

De groeps-id waaruit het besturingselement moet worden verwijderd.

Retouren

Promise<Control>

moveGroupToPage(Group, string, string, string, string, string, string, string)

Hiermee verplaatst u een groep naar een andere pagina en sectie.

function moveGroupToPage(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromPageId: string, removeFromSectionId: string): Promise<Group>

Parameters

group

Group

De bijgewerkte groep.

processId

string

De id van het proces.

witRefName

string

De verwijzingsnaam van het type werkitem.

pageId

string

De id van de pagina waarin de groep zich bevindt.

sectionId

string

De id van de sectie i.n van de groep

groupId

string

De id van de groep.

removeFromPageId

string

Id van de pagina waaruit u de groep wilt verwijderen.

removeFromSectionId

string

Id van de sectie waaruit de groep moet worden verwijderd.

Retouren

Promise<Group>

moveGroupToSection(Group, string, string, string, string, string, string)

Hiermee verplaatst u een groep naar een andere sectie.

function moveGroupToSection(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromSectionId: string): Promise<Group>

Parameters

group

Group

De bijgewerkte groep.

processId

string

De id van het proces.

witRefName

string

De verwijzingsnaam van het type werkitem.

pageId

string

De id van de pagina waarin de groep zich bevindt.

sectionId

string

De id van de sectie waarin de groep zich bevindt.

groupId

string

De id van de groep.

removeFromSectionId

string

Id van de sectie waaruit de groep moet worden verwijderd.

Retouren

Promise<Group>

removeBehaviorFromWorkItemType(string, string, string)

Hiermee verwijdert u een gedrag voor het type werkitem van het proces.

function removeBehaviorFromWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<void>

Parameters

processId

string

De ID van het proces

witRefNameForBehaviors

string

Verwijzingsnaam van werkitemtype voor het gedrag

behaviorRefName

string

De verwijzingsnaam van het gedrag

Retouren

Promise<void>

removeControlFromGroup(string, string, string, string)

Hiermee verwijdert u een besturingselement uit het werkitemformulier.

function removeControlFromGroup(processId: string, witRefName: string, groupId: string, controlId: string): Promise<void>

Parameters

processId

string

De id van het proces.

witRefName

string

De verwijzingsnaam van het type werkitem.

groupId

string

De id van de groep.

controlId

string

De id van het te verwijderen besturingselement.

Retouren

Promise<void>

removeGroup(string, string, string, string, string)

Hiermee verwijdert u een groep uit het werkitemformulier.

function removeGroup(processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise<void>

Parameters

processId

string

De ID van het proces

witRefName

string

De verwijzingsnaam van het type werkitem

pageId

string

De id van de pagina waarin de groep zich bevindt

sectionId

string

De id van de sectie voor de groep bevindt zich in

groupId

string

De id van de groep

Retouren

Promise<void>

removePage(string, string, string)

Hiermee verwijdert u een pagina uit het werkitemformulier

function removePage(processId: string, witRefName: string, pageId: string): Promise<void>

Parameters

processId

string

De ID van het proces

witRefName

string

De verwijzingsnaam van het type werkitem

pageId

string

De id van de pagina

Retouren

Promise<void>

removeWorkItemTypeField(string, string, string)

Hiermee verwijdert u een veld uit een type werkitem. Hiermee wordt het veld niet definitief verwijderd.

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

Parameters

processId

string

De id van het proces.

witRefName

string

De verwijzingsnaam van het type werkitem.

fieldRefName

string

De verwijzingsnaam van het veld.

Retouren

Promise<void>

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Updates een gedrag voor het type werkitem van het proces.

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

Parameters

behavior

WorkItemTypeBehavior

processId

string

De ID van het proces

witRefNameForBehaviors

string

Verwijzingsnaam van werkitemtype voor het gedrag

Retouren

Promise<WorkItemTypeBehavior>

updateControl(Control, string, string, string, string)

Updates een besturingselement op het werkitemformulier.

function updateControl(control: Control, processId: string, witRefName: string, groupId: string, controlId: string): Promise<Control>

Parameters

control

Control

Het bijgewerkte besturingselement.

processId

string

De id van het proces.

witRefName

string

De verwijzingsnaam van het type werkitem.

groupId

string

De id van de groep.

controlId

string

De id van het besturingselement.

Retouren

Promise<Control>

updateGroup(Group, string, string, string, string, string)

Updates een groep in het werkitemformulier.

function updateGroup(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise<Group>

Parameters

group

Group

De bijgewerkte groep.

processId

string

De id van het proces.

witRefName

string

De verwijzingsnaam van het type werkitem.

pageId

string

De id van de pagina waarin de groep zich bevindt.

sectionId

string

De id van de sectie waarin de groep zich bevindt.

groupId

string

De id van de groep.

Retouren

Promise<Group>

updateList(PickList, string)

Updates een lijst.

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

Parameters

picklist

PickList

listId

string

De id van de lijst

Retouren

Promise<PickList>

updatePage(Page, string, string)

Updates een pagina in het werkitemformulier

function updatePage(page: Page, processId: string, witRefName: string): Promise<Page>

Parameters

page

Page

De pagina

processId

string

De ID van het proces

witRefName

string

De verwijzingsnaam van het type werkitem

Retouren

Promise<Page>

updateProcessBehavior(ProcessBehaviorUpdateRequest, string, string)

Vervangt een gedrag in het proces.

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

Parameters

behaviorData

ProcessBehaviorUpdateRequest

processId

string

De ID van het proces

behaviorRefName

string

De verwijzingsnaam van het gedrag

Retouren

Promise<ProcessBehavior>

updateProcessWorkItemType(UpdateProcessWorkItemTypeRequest, string, string)

Updates een type werkitem van het proces.

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

Parameters

workItemTypeUpdate

UpdateProcessWorkItemTypeRequest

processId

string

De ID van het proces

witRefName

string

De verwijzingsnaam van het type werkitem

Retouren

Promise<ProcessWorkItemType>

updateProcessWorkItemTypeRule(UpdateProcessRuleRequest, string, string, string)

Updates een regel in het type werkitem van het proces.

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

Parameters

processRule

UpdateProcessRuleRequest

processId

string

De ID van het proces

witRefName

string

De verwijzingsnaam van het type werkitem

ruleId

string

De id van de regel

Retouren

Promise<ProcessRule>

updateStateDefinition(WorkItemStateInputModel, string, string, string)

Updates een bepaalde statusdefinitie in het type werkitem van het proces.

function updateStateDefinition(stateModel: WorkItemStateInputModel, processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>

Parameters

stateModel

WorkItemStateInputModel

processId

string

Id van het proces

witRefName

string

De verwijzingsnaam van het type werkitem

stateId

string

Id van de status

Retouren

Promise<WorkItemStateResultModel>

updateSystemControl(Control, string, string, string)

Updates/voegt een systeembesturingselement toe aan het werkitemformulier.

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

Parameters

control

Control

processId

string

De id van het proces.

witRefName

string

De verwijzingsnaam van het type werkitem.

controlId

string

De id van het besturingselement.

Retouren

Promise<Control>

updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)

Updates een veld in een type werkitem.

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

Parameters

field

UpdateProcessWorkItemTypeFieldRequest

processId

string

De id van het proces.

witRefName

string

De verwijzingsnaam van het type werkitem.

fieldRefName

string

De verwijzingsnaam van het veld.

Retouren

Promise<ProcessWorkItemTypeField>