WorkItemTrackingProcessRestClient class

Paket:: azure-devops-extension-api

Basisklasse, die verwendet werden soll (abgeleitet von), um Anforderungen an VSS-REST-APIs zu stellen

Extends: RestClientBase

Konstruktoren

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

Eigenschaften

Methoden

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Fügt dem Arbeitsaufgabentyp des Prozesses ein Verhalten hinzu.
addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)	Fügt einem Arbeitsaufgabentyp ein Feld hinzu.
addGroup(Group, string, string, string, string)	Fügt dem Arbeitsaufgabenformular eine Gruppe hinzu.
addPage(Page, string, string)	Fügt dem Arbeitsaufgabenformular eine Seite hinzu.
addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)	Fügt dem Arbeitsaufgabentyp im Prozess eine Regel hinzu.
createControlInGroup(Control, string, string, string)	Erstellt ein Steuerelement in einer Gruppe.
createList(PickList)	Erstellt eine Auswahlliste.
createNewProcess(CreateProcessModel)	Erstellt einen Prozess.
createProcessBehavior(ProcessBehaviorCreateRequest, string)	Erstellt ein einzelnes Verhalten im angegebenen Prozess.
createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)	Erstellt einen Arbeitsaufgabentyp im Prozess.
createStateDefinition(WorkItemStateInputModel, string, string)	Erstellt eine Zustandsdefinition im Arbeitsaufgabentyp des Prozesses.
deleteList(string)	Entfernt eine Auswahlliste.
deleteProcessBehavior(string, string)	Entfernt ein Verhalten im Prozess.
deleteProcessById(string)	Entfernt einen Prozess mit einer bestimmten ID.
deleteProcessWorkItemType(string, string)	Entfernt einen Arbeitsaufgabentyp im Prozess.
deleteProcessWorkItemTypeRule(string, string, string)	Entfernt eine Regel aus dem Arbeitsaufgabentyp im Prozess.
deleteStateDefinition(string, string, string)	Entfernt eine Zustandsdefinition im Arbeitsaufgabentyp des Prozesses.
deleteSystemControl(string, string, string)	Löscht eine Änderung des Systemsteuerelements im Arbeitsaufgabenformular.
editProcess(UpdateProcessModel, string)	Bearbeiten Sie einen Prozess mit einer bestimmten ID.
getAllWorkItemTypeFields(string, string)	Gibt eine Liste aller Felder in einem Arbeitsaufgabentyp zurück.
getBehaviorForWorkItemType(string, string, string)	Gibt ein Verhalten für den Arbeitsaufgabentyp des Prozesses zurück.
getBehaviorsForWorkItemType(string, string)	Gibt eine Liste aller Verhaltensweisen für den Arbeitsaufgabentyp des Prozesses zurück.
getFormLayout(string, string)	Ruft das Formularlayout ab.
getList(string)	Gibt eine Auswahlliste zurück.
getListOfProcesses(GetProcessExpandLevel)	Rufen Sie eine Liste aller Prozesse ab, einschließlich System- und geerbter Prozesse.
getListsMetadata()	Gibt die Metadaten der Auswahlliste zurück.
getProcessBehavior(string, string, GetBehaviorsExpand)	Gibt ein Verhalten des Prozesses zurück.
getProcessBehaviors(string, GetBehaviorsExpand)	Gibt eine Liste aller Verhaltensweisen im Prozess zurück.
getProcessByItsId(string, GetProcessExpandLevel)	Rufen Sie einen einzelnen Prozess einer angegebenen ID ab.
getProcessWorkItemType(string, string, GetWorkItemTypeExpand)	Gibt einen einzelnen Arbeitsaufgabentyp in einem Prozess zurück.
getProcessWorkItemTypeRule(string, string, string)	Gibt eine einzelne Regel im Arbeitsaufgabentyp des Prozesses zurück.
getProcessWorkItemTypeRules(string, string)	Gibt eine Liste aller Regeln im Arbeitsaufgabentyp des Prozesses zurück.
getProcessWorkItemTypes(string, GetWorkItemTypeExpand)	Gibt eine Liste aller Arbeitsaufgabentypen in einem Prozess zurück.
getStateDefinition(string, string, string)	Gibt eine einzelne Zustandsdefinition in einem Arbeitsaufgabentyp des Prozesses zurück.
getStateDefinitions(string, string)	Gibt eine Liste aller Zustandsdefinitionen in einem Arbeitsaufgabentyp des Prozesses zurück.
getSystemControls(string, string)	Ruft bearbeitete Systemsteuerelemente für einen Arbeitsaufgabentyp in einem Prozess ab. Um alle Systemsteuerelemente (Basis + bearbeitet) abzurufen, verwenden Sie Layout-API(s)
getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)	Gibt ein Feld in einem Arbeitsaufgabentyp zurück.
hideStateDefinition(HideStateModel, string, string, string)	Blendet eine Zustandsdefinition im Arbeitsaufgabentyp des Prozesses aus. Nur Zustände mit customizationType:System können ausgeblendet werden.
moveControlToGroup(Control, string, string, string, string, string)	Verschiebt ein Steuerelement in eine angegebene Gruppe.
moveGroupToPage(Group, string, string, string, string, string, string, string)	Verschiebt eine Gruppe auf eine andere Seite und einen anderen Abschnitt.
moveGroupToSection(Group, string, string, string, string, string, string)	Verschiebt eine Gruppe in einen anderen Abschnitt.
removeBehaviorFromWorkItemType(string, string, string)	Entfernt ein Verhalten für den Arbeitsaufgabentyp des Prozesses.
removeControlFromGroup(string, string, string, string)	Entfernt ein Steuerelement aus dem Arbeitsaufgabenformular.
removeGroup(string, string, string, string, string)	Entfernt eine Gruppe aus dem Arbeitsaufgabenformular.
removePage(string, string, string)	Entfernt eine Seite aus dem Arbeitsaufgabenformular
removeWorkItemTypeField(string, string, string)	Entfernt ein Feld aus einem Arbeitsaufgabentyp. Das Feld wird nicht dauerhaft gelöscht.
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Aktualisiert ein Verhalten für den Arbeitsaufgabentyp des Prozesses.
updateControl(Control, string, string, string, string)	Aktualisiert ein Steuerelement im Arbeitsaufgabenformular.
updateGroup(Group, string, string, string, string, string)	Aktualisiert eine Gruppe im Arbeitsaufgabenformular.
updateList(PickList, string)	Aktualisiert eine Liste.
updatePage(Page, string, string)	Aktualisiert eine Seite im Arbeitsaufgabenformular
updateProcessBehavior(ProcessBehaviorUpdateRequest, string, string)	Ersetzt ein Verhalten im Prozess.
updateProcessWorkItemType(UpdateProcessWorkItemTypeRequest, string, string)	Aktualisiert einen Arbeitsaufgabentyp des Prozesses.
updateProcessWorkItemTypeRule(UpdateProcessRuleRequest, string, string, string)	Aktualisiert eine Regel im Arbeitsaufgabentyp des Prozesses.
updateStateDefinition(WorkItemStateInputModel, string, string, string)	Aktualisiert eine bestimmte Zustandsdefinition im Arbeitsaufgabentyp des Prozesses.
updateSystemControl(Control, string, string, string)	Aktualisiert/fügt ein Systemsteuerelement im Arbeitsaufgabenformular hinzu.
updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)	Aktualisiert ein Feld in einem Arbeitsaufgabentyp.

Details zum Konstruktor

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

new WorkItemTrackingProcessRestClient(options: IVssRestClientOptions)

Parameter

options: IVssRestClientOptions

Details zur Eigenschaft

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Eigenschaftswert

string

Details zur Methode

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Fügt dem Arbeitsaufgabentyp des Prozesses ein Verhalten hinzu.

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

Parameter

behavior: WorkItemTypeBehavior

processId: string

Die ID des Prozesses

witRefNameForBehaviors: string

Verweisname des Arbeitsaufgabentyps für das Verhalten

Gibt zurück

Promise<WorkItemTypeBehavior>

addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)

Fügt einem Arbeitsaufgabentyp ein Feld hinzu.

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

Parameter

field: AddProcessWorkItemTypeFieldRequest

processId: string

Die ID des Prozesses.

witRefName: string

Der Verweisname des Arbeitsaufgabentyps.

Gibt zurück

Promise<ProcessWorkItemTypeField>

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

Fügt dem Arbeitsaufgabenformular eine Gruppe hinzu.

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

Parameter

group: Group

Die Gruppe.

processId: string

Die ID des Prozesses.

witRefName: string

Der Verweisname des Arbeitsaufgabentyps.

pageId: string

Die ID der Seite, der die Gruppe hinzugefügt werden soll.

sectionId: string

Die ID des Abschnitts, dem die Gruppe hinzugefügt werden soll.

Gibt zurück

Promise<Group>

addPage(Page, string, string)

Fügt dem Arbeitsaufgabenformular eine Seite hinzu.

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

Parameter

page: Page

Die Seite.

processId: string

Die ID des Prozesses.

witRefName: string

Der Verweisname des Arbeitsaufgabentyps.

Gibt zurück

Promise<Page>

addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)

Fügt dem Arbeitsaufgabentyp im Prozess eine Regel hinzu.

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

Parameter

processRuleCreate: CreateProcessRuleRequest

processId: string

Die ID des Prozesses

witRefName: string

Der Verweisname des Arbeitsaufgabentyps

Gibt zurück

Promise<ProcessRule>

createControlInGroup(Control, string, string, string)

Erstellt ein Steuerelement in einer Gruppe.

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

Parameter

control: Control

Die Steuerung.

processId: string

Die ID des Prozesses.

witRefName: string

Der Verweisname des Arbeitsaufgabentyps.

groupId: string

Die ID der Gruppe, der das Steuerelement hinzugefügt werden soll.

Gibt zurück

Promise<Control>

createList(PickList)

Erstellt eine Auswahlliste.

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

Parameter

picklist: PickList

Auswahlliste

Gibt zurück

Promise<PickList>

createNewProcess(CreateProcessModel)

Erstellt einen Prozess.

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

Parameter

createRequest: CreateProcessModel

CreateProcessModel.

Gibt zurück

Promise<ProcessInfo>

createProcessBehavior(ProcessBehaviorCreateRequest, string)

Erstellt ein einzelnes Verhalten im angegebenen Prozess.

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

Parameter

behavior: ProcessBehaviorCreateRequest

processId: string

Die ID des Prozesses

Gibt zurück

Promise<ProcessBehavior>

createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)

Erstellt einen Arbeitsaufgabentyp im Prozess.

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

Parameter

workItemType: CreateProcessWorkItemTypeRequest

processId: string

Die ID des Prozesses, für den der Arbeitsaufgabentyp erstellt werden soll.

Gibt zurück

Promise<ProcessWorkItemType>

createStateDefinition(WorkItemStateInputModel, string, string)

Erstellt eine Zustandsdefinition im Arbeitsaufgabentyp des Prozesses.

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

Parameter

stateModel: WorkItemStateInputModel

processId: string

Die ID des Prozesses

witRefName: string

Der Verweisname des Arbeitsaufgabentyps

Gibt zurück

Promise<WorkItemStateResultModel>

deleteList(string)

Entfernt eine Auswahlliste.

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

Parameter

listId: string

Die ID der Liste

Gibt zurück

Promise<void>

deleteProcessBehavior(string, string)

Entfernt ein Verhalten im Prozess.

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

Parameter

processId: string

Die ID des Prozesses

behaviorRefName: string

Der Referenzname des Verhaltens

Gibt zurück

Promise<void>

deleteProcessById(string)

Entfernt einen Prozess mit einer bestimmten ID.

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

Parameter

processTypeId: string

Gibt zurück

Promise<void>

deleteProcessWorkItemType(string, string)

Entfernt einen Arbeitsaufgabentyp im Prozess.

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

Parameter

processId: string

Die ID des Prozesses.

witRefName: string

Der Verweisname des Arbeitsaufgabentyps.

Gibt zurück

Promise<void>

deleteProcessWorkItemTypeRule(string, string, string)

Entfernt eine Regel aus dem Arbeitsaufgabentyp im Prozess.

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

Parameter

processId: string

Die ID des Prozesses

witRefName: string

Der Verweisname des Arbeitsaufgabentyps

ruleId: string

Die ID der Regel

Gibt zurück

Promise<void>

deleteStateDefinition(string, string, string)

Entfernt eine Zustandsdefinition im Arbeitsaufgabentyp des Prozesses.

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

Parameter

processId: string

Prozess-ID

witRefName: string

Der Verweisname des Arbeitsaufgabentyps

stateId: string

ID des Staates

Gibt zurück

Promise<void>

deleteSystemControl(string, string, string)

Löscht eine Änderung des Systemsteuerelements im Arbeitsaufgabenformular.

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

Parameter

processId: string

Die ID des Prozesses.

witRefName: string

Der Verweisname des Arbeitsaufgabentyps.

controlId: string

Die ID des Steuerelements.

Gibt zurück

Promise<Control[]>

editProcess(UpdateProcessModel, string)

Bearbeiten Sie einen Prozess mit einer bestimmten ID.

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

Parameter

updateRequest: UpdateProcessModel

processTypeId: string

Gibt zurück

Promise<ProcessInfo>

getAllWorkItemTypeFields(string, string)

Gibt eine Liste aller Felder in einem Arbeitsaufgabentyp zurück.

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

Parameter

processId: string

Die ID des Prozesses.

witRefName: string

Der Verweisname des Arbeitsaufgabentyps.

Gibt zurück

Promise<ProcessWorkItemTypeField[]>

getBehaviorForWorkItemType(string, string, string)

Gibt ein Verhalten für den Arbeitsaufgabentyp des Prozesses zurück.

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

Parameter

processId: string

Die ID des Prozesses

witRefNameForBehaviors: string

Verweisname des Arbeitsaufgabentyps für das Verhalten

behaviorRefName: string

Der Referenzname des Verhaltens

Gibt zurück

Promise<WorkItemTypeBehavior>

getBehaviorsForWorkItemType(string, string)

Gibt eine Liste aller Verhaltensweisen für den Arbeitsaufgabentyp des Prozesses zurück.

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

Parameter

processId: string

Die ID des Prozesses

witRefNameForBehaviors: string

Verweisname des Arbeitsaufgabentyps für das Verhalten

Gibt zurück

Promise<WorkItemTypeBehavior[]>

getFormLayout(string, string)

Ruft das Formularlayout ab.

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

Parameter

processId: string

Die ID des Prozesses.

witRefName: string

Der Verweisname des Arbeitsaufgabentyps.

Gibt zurück

Promise<FormLayout>

getList(string)

Gibt eine Auswahlliste zurück.

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

Parameter

listId: string

Die ID der Liste

Gibt zurück

Promise<PickList>

getListOfProcesses(GetProcessExpandLevel)

Rufen Sie eine Liste aller Prozesse ab, einschließlich System- und geerbter Prozesse.

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

Parameter

expand: GetProcessExpandLevel

Gibt zurück

Promise<ProcessInfo[]>

getListsMetadata()

Gibt die Metadaten der Auswahlliste zurück.

function getListsMetadata(): Promise<PickListMetadata[]>

Gibt zurück

Promise<PickListMetadata[]>

getProcessBehavior(string, string, GetBehaviorsExpand)

Gibt ein Verhalten des Prozesses zurück.

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

Parameter

processId: string

Die ID des Prozesses

behaviorRefName: string

Der Referenzname des Verhaltens

expand: GetBehaviorsExpand

Gibt zurück

Promise<ProcessBehavior>

getProcessBehaviors(string, GetBehaviorsExpand)

Gibt eine Liste aller Verhaltensweisen im Prozess zurück.

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

Parameter

processId: string

Die ID des Prozesses

expand: GetBehaviorsExpand

Gibt zurück

Promise<ProcessBehavior[]>

getProcessByItsId(string, GetProcessExpandLevel)

Rufen Sie einen einzelnen Prozess einer angegebenen ID ab.

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

Parameter

processTypeId: string

expand: GetProcessExpandLevel

Gibt zurück

Promise<ProcessInfo>

getProcessWorkItemType(string, string, GetWorkItemTypeExpand)

Gibt einen einzelnen Arbeitsaufgabentyp in einem Prozess zurück.

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

Parameter

processId: string

Die ID des Prozesses

witRefName: string

Der Verweisname des Arbeitsaufgabentyps

expand: GetWorkItemTypeExpand

Flag zum Bestimmen, welche Eigenschaften des Arbeitsaufgabentyps zurückgegeben werden sollen

Gibt zurück

Promise<ProcessWorkItemType>

getProcessWorkItemTypeRule(string, string, string)

Gibt eine einzelne Regel im Arbeitsaufgabentyp des Prozesses zurück.

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

Parameter

processId: string

Die ID des Prozesses

witRefName: string

Der Verweisname des Arbeitsaufgabentyps

ruleId: string

Die ID der Regel

Gibt zurück

Promise<ProcessRule>

getProcessWorkItemTypeRules(string, string)

Gibt eine Liste aller Regeln im Arbeitsaufgabentyp des Prozesses zurück.

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

Parameter

processId: string

Die ID des Prozesses

witRefName: string

Der Verweisname des Arbeitsaufgabentyps

Gibt zurück

Promise<ProcessRule[]>

getProcessWorkItemTypes(string, GetWorkItemTypeExpand)

Gibt eine Liste aller Arbeitsaufgabentypen in einem Prozess zurück.

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

Parameter

processId: string

Die ID des Prozesses

expand: GetWorkItemTypeExpand

Flag zum Bestimmen, welche Eigenschaften des Arbeitsaufgabentyps zurückgegeben werden sollen

Gibt zurück

Promise<ProcessWorkItemType[]>

getStateDefinition(string, string, string)

Gibt eine einzelne Zustandsdefinition in einem Arbeitsaufgabentyp des Prozesses zurück.

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

Parameter

processId: string

Die ID des Prozesses

witRefName: string

Der Verweisname des Arbeitsaufgabentyps

stateId: string

Die ID des Staates

Gibt zurück

Promise<WorkItemStateResultModel>

getStateDefinitions(string, string)

Gibt eine Liste aller Zustandsdefinitionen in einem Arbeitsaufgabentyp des Prozesses zurück.

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

Parameter

processId: string

Die ID des Prozesses

witRefName: string

Der Verweisname des Arbeitsaufgabentyps

Gibt zurück

Promise<WorkItemStateResultModel[]>

getSystemControls(string, string)

Ruft bearbeitete Systemsteuerelemente für einen Arbeitsaufgabentyp in einem Prozess ab. Um alle Systemsteuerelemente (Basis + bearbeitet) abzurufen, verwenden Sie Layout-API(s)

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

Parameter

processId: string

Die ID des Prozesses.

witRefName: string

Der Verweisname des Arbeitsaufgabentyps.

Gibt zurück

Promise<Control[]>

getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)

Gibt ein Feld in einem Arbeitsaufgabentyp zurück.

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

Parameter

processId: string

Die ID des Prozesses.

witRefName: string

Der Verweisname des Arbeitsaufgabentyps.

fieldRefName: string

Der Referenzname des Felds.

expand: ProcessWorkItemTypeFieldsExpandLevel

Gibt zurück

Promise<ProcessWorkItemTypeField>

hideStateDefinition(HideStateModel, string, string, string)

Blendet eine Zustandsdefinition im Arbeitsaufgabentyp des Prozesses aus. Nur Zustände mit customizationType:System können ausgeblendet werden.

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

Parameter

hideStateModel: HideStateModel

processId: string

Die ID des Prozesses

witRefName: string

Der Verweisname des Arbeitsaufgabentyps

stateId: string

Die ID des Staates

Gibt zurück

Promise<WorkItemStateResultModel>

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

Verschiebt ein Steuerelement in eine angegebene Gruppe.

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

Parameter

control: Control

Die Steuerung.

processId: string

Die ID des Prozesses.

witRefName: string

Der Verweisname des Arbeitsaufgabentyps.

groupId: string

Die ID der Gruppe, in die das Steuerelement verschoben werden soll.

controlId: string

Die ID des Steuerelements.

removeFromGroupId: string

Die Gruppen-ID, aus der das Steuerelement entfernt werden soll.

Gibt zurück

Promise<Control>

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

Verschiebt eine Gruppe auf eine andere Seite und einen anderen Abschnitt.

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

Parameter

group: Group

Die aktualisierte Gruppe.

processId: string

Die ID des Prozesses.

witRefName: string

Der Verweisname des Arbeitsaufgabentyps.

pageId: string

Die ID der Seite, auf der sich die Gruppe befindet.

sectionId: string

Die ID der Sektion, in der die Gruppe ist, ist i.n

groupId: string

Die ID der Gruppe.

removeFromPageId: string

ID der Seite, von der die Gruppe entfernt werden soll.

removeFromSectionId: string

ID des Abschnitts, aus dem die Gruppe entfernt werden soll.

Gibt zurück

Promise<Group>

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

Verschiebt eine Gruppe in einen anderen Abschnitt.

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

Parameter

group: Group

Die aktualisierte Gruppe.

processId: string

Die ID des Prozesses.

witRefName: string

Der Verweisname des Arbeitsaufgabentyps.

pageId: string

Die ID der Seite, auf der sich die Gruppe befindet.

sectionId: string

Die ID des Abschnitts, in dem sich die Gruppe befindet.

groupId: string

Die ID der Gruppe.

removeFromSectionId: string

ID des Abschnitts, aus dem die Gruppe entfernt werden soll.

Gibt zurück

Promise<Group>

removeBehaviorFromWorkItemType(string, string, string)

Entfernt ein Verhalten für den Arbeitsaufgabentyp des Prozesses.

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

Parameter

processId: string

Die ID des Prozesses

witRefNameForBehaviors: string

Verweisname des Arbeitsaufgabentyps für das Verhalten

behaviorRefName: string

Der Referenzname des Verhaltens

Gibt zurück

Promise<void>

removeControlFromGroup(string, string, string, string)

Entfernt ein Steuerelement aus dem Arbeitsaufgabenformular.

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

Parameter

processId: string

Die ID des Prozesses.

witRefName: string

Der Verweisname des Arbeitsaufgabentyps.

groupId: string

Die ID der Gruppe.

controlId: string

Die ID des Steuerelements, das entfernt werden soll.

Gibt zurück

Promise<void>

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

Entfernt eine Gruppe aus dem Arbeitsaufgabenformular.

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

Parameter

processId: string

Die ID des Prozesses

witRefName: string

Der Verweisname des Arbeitsaufgabentyps

pageId: string

Die ID der Seite, auf der sich die Gruppe befindet

sectionId: string

Die ID des Abschnitts zur Gruppe befindet sich in

groupId: string

Die ID der Gruppe

Gibt zurück

Promise<void>

removePage(string, string, string)

Entfernt eine Seite aus dem Arbeitsaufgabenformular

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

Parameter

processId: string

Die ID des Prozesses

witRefName: string

Der Verweisname des Arbeitsaufgabentyps

pageId: string

Die ID der Seite

Gibt zurück

Promise<void>

removeWorkItemTypeField(string, string, string)

Entfernt ein Feld aus einem Arbeitsaufgabentyp. Das Feld wird nicht dauerhaft gelöscht.

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

Parameter

processId: string

Die ID des Prozesses.

witRefName: string

Der Verweisname des Arbeitsaufgabentyps.

fieldRefName: string

Der Referenzname des Felds.

Gibt zurück

Promise<void>

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Aktualisiert ein Verhalten für den Arbeitsaufgabentyp des Prozesses.

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

Parameter

behavior: WorkItemTypeBehavior

processId: string

Die ID des Prozesses

witRefNameForBehaviors: string

Verweisname des Arbeitsaufgabentyps für das Verhalten

Gibt zurück

Promise<WorkItemTypeBehavior>

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

Aktualisiert ein Steuerelement im Arbeitsaufgabenformular.

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

Parameter

control: Control

Das aktualisierte Steuerelement.

processId: string

Die ID des Prozesses.

witRefName: string

Der Verweisname des Arbeitsaufgabentyps.

groupId: string

Die ID der Gruppe.

controlId: string

Die ID des Steuerelements.

Gibt zurück

Promise<Control>

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

Aktualisiert eine Gruppe im Arbeitsaufgabenformular.

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

Parameter

group: Group

Die aktualisierte Gruppe.

processId: string

Die ID des Prozesses.

witRefName: string

Der Verweisname des Arbeitsaufgabentyps.

pageId: string

Die ID der Seite, auf der sich die Gruppe befindet.

sectionId: string

Die ID des Abschnitts, in dem sich die Gruppe befindet.

groupId: string

Die ID der Gruppe.

Gibt zurück

Promise<Group>

updateList(PickList, string)

Aktualisiert eine Liste.

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

Parameter

picklist: PickList

listId: string

Die ID der Liste

Gibt zurück

Promise<PickList>

updatePage(Page, string, string)

Aktualisiert eine Seite im Arbeitsaufgabenformular

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

Parameter

page: Page

Die Seite

processId: string

Die ID des Prozesses

witRefName: string

Der Verweisname des Arbeitsaufgabentyps

Gibt zurück

Promise<Page>

updateProcessBehavior(ProcessBehaviorUpdateRequest, string, string)

Ersetzt ein Verhalten im Prozess.

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

Parameter

behaviorData: ProcessBehaviorUpdateRequest

processId: string

Die ID des Prozesses

behaviorRefName: string

Der Referenzname des Verhaltens

Gibt zurück

Promise<ProcessBehavior>

updateProcessWorkItemType(UpdateProcessWorkItemTypeRequest, string, string)

Aktualisiert einen Arbeitsaufgabentyp des Prozesses.

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

Parameter

workItemTypeUpdate: UpdateProcessWorkItemTypeRequest

processId: string

Die ID des Prozesses

witRefName: string

Der Verweisname des Arbeitsaufgabentyps

Gibt zurück

Promise<ProcessWorkItemType>

updateProcessWorkItemTypeRule(UpdateProcessRuleRequest, string, string, string)

Aktualisiert eine Regel im Arbeitsaufgabentyp des Prozesses.

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

Parameter

processRule: UpdateProcessRuleRequest

processId: string

Die ID des Prozesses

witRefName: string

Der Verweisname des Arbeitsaufgabentyps

ruleId: string

Die ID der Regel

Gibt zurück

Promise<ProcessRule>

updateStateDefinition(WorkItemStateInputModel, string, string, string)

Aktualisiert eine bestimmte Zustandsdefinition im Arbeitsaufgabentyp des Prozesses.

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

Parameter

stateModel: WorkItemStateInputModel

processId: string

Prozess-ID

witRefName: string

Der Verweisname des Arbeitsaufgabentyps

stateId: string

ID des Staates

Gibt zurück

Promise<WorkItemStateResultModel>

updateSystemControl(Control, string, string, string)

Aktualisiert/fügt ein Systemsteuerelement im Arbeitsaufgabenformular hinzu.

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

Parameter

control: Control

processId: string

Die ID des Prozesses.

witRefName: string

Der Verweisname des Arbeitsaufgabentyps.

controlId: string

Die ID des Steuerelements.

Gibt zurück

Promise<Control>

updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)

Aktualisiert ein Feld in einem Arbeitsaufgabentyp.

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

Parameter

field: UpdateProcessWorkItemTypeFieldRequest

processId: string

Die ID des Prozesses.

witRefName: string

Der Verweisname des Arbeitsaufgabentyps.

fieldRefName: string

Der Referenzname des Felds.

Gibt zurück

Promise<ProcessWorkItemTypeField>

Feedback

War diese Seite hilfreich?

Freigeben über

WorkItemTrackingProcessRestClient class

Konstruktoren

Eigenschaften

Methoden

Details zum Konstruktor

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

Parameter

Details zur Eigenschaft

RESOURCE_AREA_ID

Eigenschaftswert

Details zur Methode

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Parameter

Gibt zurück

addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)

Parameter

Gibt zurück

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

Parameter

Gibt zurück

addPage(Page, string, string)

Parameter

Gibt zurück

addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)

Parameter

Gibt zurück

createControlInGroup(Control, string, string, string)

Parameter

Gibt zurück

createList(PickList)

Parameter

Gibt zurück

createNewProcess(CreateProcessModel)

Parameter

Gibt zurück

createProcessBehavior(ProcessBehaviorCreateRequest, string)

Parameter

Gibt zurück

createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)

Parameter

Gibt zurück

createStateDefinition(WorkItemStateInputModel, string, string)

Parameter

Gibt zurück

deleteList(string)

Parameter

Gibt zurück

deleteProcessBehavior(string, string)

Parameter

Gibt zurück

deleteProcessById(string)

Parameter

Gibt zurück

deleteProcessWorkItemType(string, string)

Parameter

Gibt zurück

deleteProcessWorkItemTypeRule(string, string, string)

Parameter

Gibt zurück

deleteStateDefinition(string, string, string)

Parameter

Gibt zurück

deleteSystemControl(string, string, string)

Parameter

Gibt zurück

editProcess(UpdateProcessModel, string)

Parameter

Gibt zurück

getAllWorkItemTypeFields(string, string)

Parameter

Gibt zurück

getBehaviorForWorkItemType(string, string, string)

Parameter

Gibt zurück

getBehaviorsForWorkItemType(string, string)

Parameter

Gibt zurück

getFormLayout(string, string)

Parameter