WorkItemTrackingProcessRestClient class

Referens

Paket:: azure-devops-extension-api

Basklass som ska användas (härledd från) för att göra begäranden till VSS REST API:erna

Extends: RestClientBase

Konstruktorer

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

Egenskaper

RESOURCE_AREA_ID

Metoder

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Lägger till ett beteende i arbetsobjekttypen för processen.
addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)	Lägger till ett fält i en typ av arbetsobjekt.
addGroup(Group, string, string, string, string)	Lägger till en grupp i arbetsobjektsformuläret.
addPage(Page, string, string)	Lägger till en sida i arbetsobjektsformuläret.
addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)	Lägger till en regel i arbetsobjekttypen i processen.
createControlInGroup(Control, string, string, string)	Skapar en kontroll i en grupp.
createList(PickList)	Skapar en listruta.
createNewProcess(CreateProcessModel)	Skapar en process.
createProcessBehavior(ProcessBehaviorCreateRequest, string)	Skapar ett enda beteende i den angivna processen.
createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)	Skapar en typ av arbetsobjekt i processen.
createStateDefinition(WorkItemStateInputModel, string, string)	Skapar en tillståndsdefinition i arbetsobjekttypen för processen.
deleteList(string)	Tar bort en listruta.
deleteProcessBehavior(string, string)	Tar bort ett beteende i processen.
deleteProcessById(string)	Tar bort en process med ett specifikt ID.
deleteProcessWorkItemType(string, string)	Tar bort en typ av arbetsobjekt i processen.
deleteProcessWorkItemTypeRule(string, string, string)	Tar bort en regel från arbetsobjekttypen i processen.
deleteStateDefinition(string, string, string)	Tar bort en tillståndsdefinition i arbetsobjekttypen för processen.
deleteSystemControl(string, string, string)	Tar bort en systemkontrolländring i arbetsobjektsformuläret.
editProcess(UpdateProcessModel, string)	Redigera en process med ett specifikt ID.
getAllWorkItemTypeFields(string, string)	Returnerar en lista över alla fält i en arbetsobjektstyp.
getBehaviorForWorkItemType(string, string, string)	Returnerar ett beteende för processens arbetsobjekttyp.
getBehaviorsForWorkItemType(string, string)	Returnerar en lista över alla beteenden för processens arbetsobjektstyp.
getFormLayout(string, string)	Hämtar formulärlayouten.
getList(string)	Returnerar en listruta.
getListOfProcesses(GetProcessExpandLevel)	Hämta en lista över alla processer, inklusive system och ärvda.
getListsMetadata()	Returnerar metadata för listrutan.
getProcessBehavior(string, string, GetBehaviorsExpand)	Returnerar ett beteende för processen.
getProcessBehaviors(string, GetBehaviorsExpand)	Returnerar en lista över alla beteenden i processen.
getProcessByItsId(string, GetProcessExpandLevel)	Hämta en enda process med ett angivet ID.
getProcessWorkItemType(string, string, GetWorkItemTypeExpand)	Returnerar en enskild typ av arbetsobjekt i en process.
getProcessWorkItemTypeRule(string, string, string)	Returnerar en enskild regel i arbetsobjekttypen för processen.
getProcessWorkItemTypeRules(string, string)	Returnerar en lista över alla regler i processens arbetsobjektstyp.
getProcessWorkItemTypes(string, GetWorkItemTypeExpand)	Returnerar en lista över alla typer av arbetsobjekt i en process.
getStateDefinition(string, string, string)	Returnerar en enskild tillståndsdefinition i en arbetsobjekttyp i processen.
getStateDefinitions(string, string)	Returnerar en lista över alla tillståndsdefinitioner i en arbetsobjektstyp i processen.
getSystemControls(string, string)	Hämtar redigerade systemkontroller för en arbetsobjekttyp i en process. Om du vill hämta alla systemkontroller (bas + redigerad) använder du layout-API:er
getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)	Returnerar ett fält i en typ av arbetsobjekt.
hideStateDefinition(HideStateModel, string, string, string)	Döljer en tillståndsdefinition i arbetsobjekttypen för processen. Endast tillstånd med customizationType:System kan döljas.
moveControlToGroup(Control, string, string, string, string, string)	Flyttar en kontroll till en angiven grupp.
moveGroupToPage(Group, string, string, string, string, string, string, string)	Flyttar en grupp till en annan sida och ett annat avsnitt.
moveGroupToSection(Group, string, string, string, string, string, string)	Flyttar en grupp till ett annat avsnitt.
removeBehaviorFromWorkItemType(string, string, string)	Tar bort ett beteende för processens arbetsobjekttyp.
removeControlFromGroup(string, string, string, string)	Tar bort en kontroll från arbetsobjektsformuläret.
removeGroup(string, string, string, string, string)	Tar bort en grupp från arbetsobjektsformuläret.
removePage(string, string, string)	Tar bort en sida från arbetsobjektsformuläret
removeWorkItemTypeField(string, string, string)	Tar bort ett fält från en typ av arbetsobjekt. Tar inte bort fältet permanent.
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Uppdateringar ett beteende för processens arbetsobjektstyp.
updateControl(Control, string, string, string, string)	Uppdateringar en kontroll i arbetsobjektsformuläret.
updateGroup(Group, string, string, string, string, string)	Uppdateringar en grupp i arbetsobjektsformuläret.
updateList(PickList, string)	Uppdateringar en lista.
updatePage(Page, string, string)	Uppdateringar en sida i arbetsobjektsformuläret
updateProcessBehavior(ProcessBehaviorUpdateRequest, string, string)	Ersätter ett beteende i processen.
updateProcessWorkItemType(UpdateProcessWorkItemTypeRequest, string, string)	Uppdateringar en arbetsuppgiftstyp i processen.
updateProcessWorkItemTypeRule(UpdateProcessRuleRequest, string, string, string)	Uppdateringar en regel i arbetsobjekttypen för processen.
updateStateDefinition(WorkItemStateInputModel, string, string, string)	Uppdateringar en viss tillståndsdefinition i arbetsobjekttypen för processen.
updateSystemControl(Control, string, string, string)	Uppdateringar/lägger till en systemkontroll i arbetsobjektsformuläret.
updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)	Uppdateringar ett fält i en arbetsobjekttyp.

Konstruktorinformation

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

new WorkItemTrackingProcessRestClient(options: IVssRestClientOptions)

Parametrar

options: IVssRestClientOptions

Egenskapsinformation

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Egenskapsvärde

string

Metodinformation

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Lägger till ett beteende i arbetsobjekttypen för processen.

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

Parametrar

behavior: WorkItemTypeBehavior

processId: string

Processens ID

witRefNameForBehaviors: string

Referensnamn för arbetsobjekttyp för beteendet

Returer

Promise<WorkItemTypeBehavior>

addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)

Lägger till ett fält i en typ av arbetsobjekt.

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

Parametrar

field: AddProcessWorkItemTypeFieldRequest

processId: string

ID för processen.

witRefName: string

Referensnamnet för arbetsobjekttypen.

Returer

Promise<ProcessWorkItemTypeField>

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

Lägger till en grupp i arbetsobjektsformuläret.

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

Parametrar

group: Group

Gruppen.

processId: string

ID för processen.

witRefName: string

Referensnamnet för arbetsobjekttypen.

pageId: string

Sidans ID som gruppen ska läggas till i.

sectionId: string

ID:t för avsnittet som gruppen ska läggas till i.

Returer

Promise<Group>

addPage(Page, string, string)

Lägger till en sida i arbetsobjektsformuläret.

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

Parametrar

page: Page

Sidan.

processId: string

ID för processen.

witRefName: string

Referensnamnet för arbetsobjekttypen.

Returer

Promise<Page>

addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)

Lägger till en regel i arbetsobjekttypen i processen.

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

Parametrar

processRuleCreate: CreateProcessRuleRequest

processId: string

Processens ID

witRefName: string

Referensnamnet för arbetsobjekttypen

Returer

Promise<ProcessRule>

createControlInGroup(Control, string, string, string)

Skapar en kontroll i en grupp.

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

Parametrar

control: Control

Kontrollen.

processId: string

ID för processen.

witRefName: string

Referensnamnet för arbetsobjekttypen.

groupId: string

ID:t för gruppen som kontrollen ska läggas till i.

Returer

Promise<Control>

createList(PickList)

Skapar en listruta.

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

Parametrar

picklist: PickList

Picklist (Plocklista)

Returer

Promise<PickList>

createNewProcess(CreateProcessModel)

Skapar en process.

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

Parametrar

createRequest: CreateProcessModel

CreateProcessModel.

Returer

Promise<ProcessInfo>

createProcessBehavior(ProcessBehaviorCreateRequest, string)

Skapar ett enda beteende i den angivna processen.

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

Parametrar

behavior: ProcessBehaviorCreateRequest

processId: string

Processens ID

Returer

Promise<ProcessBehavior>

createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)

Skapar en typ av arbetsobjekt i processen.

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

Parametrar

workItemType: CreateProcessWorkItemTypeRequest

processId: string

ID:t för processen där arbetsobjektstypen ska skapas.

Returer

Promise<ProcessWorkItemType>

createStateDefinition(WorkItemStateInputModel, string, string)

Skapar en tillståndsdefinition i arbetsobjekttypen för processen.

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

Parametrar

stateModel: WorkItemStateInputModel

processId: string

Processens ID

witRefName: string

Referensnamnet för arbetsobjekttypen

Returer

Promise<WorkItemStateResultModel>

deleteList(string)

Tar bort en listruta.

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

Parametrar

listId: string

ID:t för listan

Returer

Promise<void>

deleteProcessBehavior(string, string)

Tar bort ett beteende i processen.

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

Parametrar

processId: string

Processens ID

behaviorRefName: string

Beteendets referensnamn

Returer

Promise<void>

deleteProcessById(string)

Tar bort en process med ett specifikt ID.

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

Parametrar

processTypeId: string

Returer

Promise<void>

deleteProcessWorkItemType(string, string)

Tar bort en typ av arbetsobjekt i processen.

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

Parametrar

processId: string

ID för processen.

witRefName: string

Referensnamnet för arbetsobjekttypen.

Returer

Promise<void>

deleteProcessWorkItemTypeRule(string, string, string)

Tar bort en regel från arbetsobjekttypen i processen.

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

Parametrar

processId: string

Processens ID

witRefName: string

Referensnamnet för arbetsobjekttypen

ruleId: string

ID för regeln

Returer

Promise<void>

deleteStateDefinition(string, string, string)

Tar bort en tillståndsdefinition i arbetsobjekttypen för processen.

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

Parametrar

processId: string

ID för processen

witRefName: string

Referensnamnet för arbetsobjekttypen

stateId: string

ID för tillståndet

Returer

Promise<void>

deleteSystemControl(string, string, string)

Tar bort en systemkontrolländring i arbetsobjektsformuläret.

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

Parametrar

processId: string

ID för processen.

witRefName: string

Referensnamnet för arbetsobjekttypen.

controlId: string

Kontrollens ID.

Returer

Promise<Control[]>

editProcess(UpdateProcessModel, string)

Redigera en process med ett specifikt ID.

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

Parametrar

updateRequest: UpdateProcessModel

processTypeId: string

Returer

Promise<ProcessInfo>

getAllWorkItemTypeFields(string, string)

Returnerar en lista över alla fält i en arbetsobjektstyp.

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

Parametrar

processId: string

ID för processen.

witRefName: string

Referensnamnet för arbetsobjekttypen.

Returer

Promise<ProcessWorkItemTypeField[]>

getBehaviorForWorkItemType(string, string, string)

Returnerar ett beteende för processens arbetsobjekttyp.

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

Parametrar

processId: string

Processens ID

witRefNameForBehaviors: string

Referensnamn för arbetsobjekttyp för beteendet

behaviorRefName: string

Beteendets referensnamn

Returer

Promise<WorkItemTypeBehavior>

getBehaviorsForWorkItemType(string, string)

Returnerar en lista över alla beteenden för processens arbetsobjektstyp.

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

Parametrar

processId: string

Processens ID

witRefNameForBehaviors: string

Referensnamn för arbetsobjekttyp för beteendet

Returer

Promise<WorkItemTypeBehavior[]>

getFormLayout(string, string)

Hämtar formulärlayouten.

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

Parametrar

processId: string

ID för processen.

witRefName: string

Referensnamnet för arbetsobjekttypen.

Returer

Promise<FormLayout>

getList(string)

Returnerar en listruta.

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

Parametrar

listId: string

ID:t för listan

Returer

Promise<PickList>

getListOfProcesses(GetProcessExpandLevel)

Hämta en lista över alla processer, inklusive system och ärvda.

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

Parametrar

expand: GetProcessExpandLevel

Returer

Promise<ProcessInfo[]>

getListsMetadata()

Returnerar metadata för listrutan.

function getListsMetadata(): Promise<PickListMetadata[]>

Returer

Promise<PickListMetadata[]>

getProcessBehavior(string, string, GetBehaviorsExpand)

Returnerar ett beteende för processen.

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

Parametrar

processId: string

Processens ID

behaviorRefName: string

Beteendets referensnamn

expand: GetBehaviorsExpand

Returer

Promise<ProcessBehavior>

getProcessBehaviors(string, GetBehaviorsExpand)

Returnerar en lista över alla beteenden i processen.

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

Parametrar

processId: string

Processens ID

expand: GetBehaviorsExpand

Returer

Promise<ProcessBehavior[]>

getProcessByItsId(string, GetProcessExpandLevel)

Hämta en enda process med ett angivet ID.

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

Parametrar

processTypeId: string

expand: GetProcessExpandLevel

Returer

Promise<ProcessInfo>

getProcessWorkItemType(string, string, GetWorkItemTypeExpand)

Returnerar en enskild typ av arbetsobjekt i en process.

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

Parametrar

processId: string

Processens ID

witRefName: string

Referensnamnet för arbetsobjekttypen

expand: GetWorkItemTypeExpand

Flagga för att avgöra vilka egenskaper av arbetsobjekttyp som ska returneras

Returer

Promise<ProcessWorkItemType>

getProcessWorkItemTypeRule(string, string, string)

Returnerar en enskild regel i arbetsobjekttypen för processen.

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

Parametrar

processId: string

Processens ID

witRefName: string

Referensnamnet för arbetsobjekttypen

ruleId: string

ID för regeln

Returer

Promise<ProcessRule>

getProcessWorkItemTypeRules(string, string)

Returnerar en lista över alla regler i processens arbetsobjektstyp.

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

Parametrar

processId: string

Processens ID

witRefName: string

Referensnamnet för arbetsobjekttypen

Returer

Promise<ProcessRule[]>

getProcessWorkItemTypes(string, GetWorkItemTypeExpand)

Returnerar en lista över alla typer av arbetsobjekt i en process.

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

Parametrar

processId: string

Processens ID

expand: GetWorkItemTypeExpand

Flagga för att avgöra vilka egenskaper av arbetsobjekttyp som ska returneras

Returer

Promise<ProcessWorkItemType[]>

getStateDefinition(string, string, string)

Returnerar en enskild tillståndsdefinition i en arbetsobjekttyp i processen.

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

Parametrar

processId: string

Processens ID

witRefName: string

Referensnamnet för arbetsobjekttypen

stateId: string

Tillståndets ID

Returer

Promise<WorkItemStateResultModel>

getStateDefinitions(string, string)

Returnerar en lista över alla tillståndsdefinitioner i en arbetsobjektstyp i processen.

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

Parametrar

processId: string

Processens ID

witRefName: string

Referensnamnet för arbetsobjekttypen

Returer

Promise<WorkItemStateResultModel[]>

getSystemControls(string, string)

Hämtar redigerade systemkontroller för en arbetsobjekttyp i en process. Om du vill hämta alla systemkontroller (bas + redigerad) använder du layout-API:er

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

Parametrar

processId: string

ID för processen.

witRefName: string

Referensnamnet för arbetsobjekttypen.

Returer

Promise<Control[]>

getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)

Returnerar ett fält i en typ av arbetsobjekt.

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

Parametrar

processId: string

ID för processen.

witRefName: string

Referensnamnet för arbetsobjekttypen.

fieldRefName: string

Fältets referensnamn.

expand: ProcessWorkItemTypeFieldsExpandLevel

Returer

Promise<ProcessWorkItemTypeField>

hideStateDefinition(HideStateModel, string, string, string)

Döljer en tillståndsdefinition i arbetsobjekttypen för processen. Endast tillstånd med customizationType:System kan döljas.

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

Parametrar

hideStateModel: HideStateModel

processId: string

Processens ID

witRefName: string

Referensnamnet för arbetsobjekttypen

stateId: string

Tillståndets ID

Returer

Promise<WorkItemStateResultModel>

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

Flyttar en kontroll till en angiven grupp.

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

Parametrar

control: Control

Kontrollen.

processId: string

ID för processen.

witRefName: string

Referensnamnet för arbetsobjekttypen.

groupId: string

ID:t för gruppen som kontrollen ska flyttas till.

controlId: string

Kontrollens ID.

removeFromGroupId: string

Grupp-ID:t som kontrollen ska tas bort från.

Returer

Promise<Control>

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

Flyttar en grupp till en annan sida och ett annat avsnitt.

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

Parametrar

group: Group

Den uppdaterade gruppen.

processId: string

ID för processen.

witRefName: string

Referensnamnet för arbetsobjekttypen.

pageId: string

ID:t för sidan som gruppen finns på.

sectionId: string

ID:t för avsnittet som gruppen är i.n

groupId: string

ID för gruppen.

removeFromPageId: string

ID för sidan som gruppen ska tas bort från.

removeFromSectionId: string

ID för avsnittet som gruppen ska tas bort från.

Returer

Promise<Group>

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

Flyttar en grupp till ett annat avsnitt.

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

Parametrar

group: Group

Den uppdaterade gruppen.

processId: string

ID för processen.

witRefName: string

Referensnamnet för arbetsobjekttypen.

pageId: string

ID:t för sidan som gruppen finns på.

sectionId: string

ID:t för avsnittet som gruppen finns i.

groupId: string

ID för gruppen.

removeFromSectionId: string

ID för avsnittet som gruppen ska tas bort från.

Returer

Promise<Group>

removeBehaviorFromWorkItemType(string, string, string)

Tar bort ett beteende för processens arbetsobjekttyp.

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

Parametrar

processId: string

Processens ID

witRefNameForBehaviors: string

Referensnamn för arbetsobjekttyp för beteendet

behaviorRefName: string

Beteendets referensnamn

Returer

Promise<void>

removeControlFromGroup(string, string, string, string)

Tar bort en kontroll från arbetsobjektsformuläret.

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

Parametrar

processId: string

ID för processen.

witRefName: string

Referensnamnet för arbetsobjekttypen.

groupId: string

ID för gruppen.

controlId: string

ID för kontrollen som ska tas bort.

Returer

Promise<void>

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

Tar bort en grupp från arbetsobjektsformuläret.

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

Parametrar

processId: string

Processens ID

witRefName: string

Referensnamnet för arbetsobjekttypen

pageId: string

ID:t för sidan som gruppen finns i

sectionId: string

ID:t för avsnittet till gruppen finns i

groupId: string

ID för gruppen

Returer

Promise<void>

removePage(string, string, string)

Tar bort en sida från arbetsobjektsformuläret

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

Parametrar

processId: string

Processens ID

witRefName: string

Referensnamnet för arbetsobjekttypen

pageId: string

Sidans ID

Returer

Promise<void>

removeWorkItemTypeField(string, string, string)

Tar bort ett fält från en typ av arbetsobjekt. Tar inte bort fältet permanent.

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

Parametrar

processId: string

ID för processen.

witRefName: string

Referensnamnet för arbetsobjekttypen.

fieldRefName: string

Fältets referensnamn.

Returer

Promise<void>

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Uppdateringar ett beteende för processens arbetsobjektstyp.

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

Parametrar

behavior: WorkItemTypeBehavior

processId: string

Processens ID

witRefNameForBehaviors: string

Referensnamn för arbetsobjekttyp för beteendet

Returer

Promise<WorkItemTypeBehavior>

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

Uppdateringar en kontroll i arbetsobjektsformuläret.

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

Parametrar

control: Control

Den uppdaterade kontrollen.

processId: string

ID för processen.

witRefName: string

Referensnamnet för arbetsobjekttypen.

groupId: string

ID för gruppen.

controlId: string

Kontrollens ID.

Returer

Promise<Control>

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

Uppdateringar en grupp i arbetsobjektsformuläret.

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

Parametrar

group: Group

Den uppdaterade gruppen.

processId: string

ID för processen.

witRefName: string

Referensnamnet för arbetsobjekttypen.

pageId: string

ID:t för sidan som gruppen finns på.

sectionId: string

ID:t för avsnittet som gruppen finns i.

groupId: string

ID för gruppen.

Returer

Promise<Group>

updateList(PickList, string)

Uppdateringar en lista.

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

Parametrar

picklist: PickList

listId: string

ID:t för listan

Returer

Promise<PickList>

updatePage(Page, string, string)

Uppdateringar en sida i arbetsobjektsformuläret

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

Parametrar

page: Page

Sidan

processId: string

Processens ID

witRefName: string

Referensnamnet för arbetsobjekttypen

Returer

Promise<Page>

updateProcessBehavior(ProcessBehaviorUpdateRequest, string, string)

Ersätter ett beteende i processen.

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

Parametrar

behaviorData: ProcessBehaviorUpdateRequest

processId: string

Processens ID

behaviorRefName: string

Beteendets referensnamn

Returer

Promise<ProcessBehavior>

updateProcessWorkItemType(UpdateProcessWorkItemTypeRequest, string, string)

Uppdateringar en arbetsuppgiftstyp i processen.

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

Parametrar

workItemTypeUpdate: UpdateProcessWorkItemTypeRequest

processId: string

Processens ID

witRefName: string

Referensnamnet för arbetsobjekttypen

Returer

Promise<ProcessWorkItemType>

updateProcessWorkItemTypeRule(UpdateProcessRuleRequest, string, string, string)

Uppdateringar en regel i arbetsobjekttypen för processen.

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

Parametrar

processRule: UpdateProcessRuleRequest

processId: string

Processens ID

witRefName: string

Referensnamnet för arbetsobjekttypen

ruleId: string

Regelns ID

Returer

Promise<ProcessRule>

updateStateDefinition(WorkItemStateInputModel, string, string, string)

Uppdateringar en viss tillståndsdefinition i arbetsobjekttypen för processen.

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

Parametrar

stateModel: WorkItemStateInputModel

processId: string

ID för processen

witRefName: string

Referensnamnet för arbetsobjekttypen

stateId: string

ID för tillståndet

Returer

Promise<WorkItemStateResultModel>

updateSystemControl(Control, string, string, string)

Uppdateringar/lägger till en systemkontroll i arbetsobjektsformuläret.

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

Parametrar

control: Control

processId: string

ID:t för processen.

witRefName: string

Referensnamnet för arbetsobjekttypen.

controlId: string

Kontrollens ID.

Returer

Promise<Control>

updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)

Uppdateringar ett fält i en arbetsobjekttyp.

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

Parametrar

field: UpdateProcessWorkItemTypeFieldRequest

processId: string

ID:t för processen.

witRefName: string

Referensnamnet för arbetsobjekttypen.

fieldRefName: string

Fältets referensnamn.

Returer

Promise<ProcessWorkItemTypeField>

Dela via

WorkItemTrackingProcessRestClient class

Konstruktorer

Egenskaper

Metoder

Konstruktorinformation

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

Parametrar

Egenskapsinformation

RESOURCE_AREA_ID

Egenskapsvärde

Metodinformation

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Parametrar

Returer

addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)

Parametrar

Returer

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

Parametrar

Returer

addPage(Page, string, string)

Parametrar

Returer

addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)

Parametrar

Returer

createControlInGroup(Control, string, string, string)

Parametrar

Returer

createList(PickList)

Parametrar

Returer

createNewProcess(CreateProcessModel)

Parametrar

Returer

createProcessBehavior(ProcessBehaviorCreateRequest, string)

Parametrar

Returer

createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)

Parametrar

Returer

createStateDefinition(WorkItemStateInputModel, string, string)

Parametrar

Returer

deleteList(string)

Parametrar

Returer

deleteProcessBehavior(string, string)

Parametrar

Returer

deleteProcessById(string)

Parametrar

Returer

deleteProcessWorkItemType(string, string)

Parametrar

Returer

deleteProcessWorkItemTypeRule(string, string, string)

Parametrar

Returer

deleteStateDefinition(string, string, string)

Parametrar

Returer

deleteSystemControl(string, string, string)

Parametrar

Returer

editProcess(UpdateProcessModel, string)

Parametrar

Returer

getAllWorkItemTypeFields(string, string)

Parametrar

Returer

getBehaviorForWorkItemType(string, string, string)

Parametrar

Returer

getBehaviorsForWorkItemType(string, string)

Parametrar

Returer

getFormLayout(string, string)

Parametrar