WorkItemTrackingProcessRestClient class

Pakiet:: azure-devops-extension-api

Klasa bazowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Rozszerzenie: RestClientBase

Konstruktory

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

Właściwości

Metody

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Dodaje zachowanie do typu elementu roboczego procesu.
addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)	Dodaje pole do typu elementu roboczego.
addGroup(Group, string, string, string, string)	Dodaje grupę do formularza elementu roboczego.
addPage(Page, string, string)	Dodaje stronę do formularza elementu roboczego.
addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)	Dodaje regułę do typu elementu roboczego w procesie.
createControlInGroup(Control, string, string, string)	Tworzy formant w grupie.
createList(PickList)	Tworzy listę wyboru.
createNewProcess(CreateProcessModel)	Tworzy proces.
createProcessBehavior(ProcessBehaviorCreateRequest, string)	Tworzy pojedyncze zachowanie w danym procesie.
createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)	Tworzy typ elementu roboczego w procesie.
createStateDefinition(WorkItemStateInputModel, string, string)	Tworzy definicję stanu w typie elementu roboczego procesu.
deleteList(string)	Usuwa listę wyboru.
deleteProcessBehavior(string, string)	Usuwa zachowanie w procesie.
deleteProcessById(string)	Usuwa proces o określonym identyfikatorze.
deleteProcessWorkItemType(string, string)	Usuwa typ elementu roboczego w procesie.
deleteProcessWorkItemTypeRule(string, string, string)	Usuwa regułę z typu elementu roboczego w procesie.
deleteStateDefinition(string, string, string)	Usuwa definicję stanu w typie elementu roboczego procesu.
deleteSystemControl(string, string, string)	Usuwa modyfikację formantu systemu w formularzu elementu roboczego.
editProcess(UpdateProcessModel, string)	Edytowanie procesu o określonym identyfikatorze.
getAllWorkItemTypeFields(string, string)	Zwraca listę wszystkich pól w typie elementu roboczego.
getBehaviorForWorkItemType(string, string, string)	Zwraca zachowanie dla typu elementu roboczego procesu.
getBehaviorsForWorkItemType(string, string)	Zwraca listę wszystkich zachowań dla typu elementu roboczego procesu.
getFormLayout(string, string)	Pobiera układ formularza.
getList(string)	Zwraca listę wyboru.
getListOfProcesses(GetProcessExpandLevel)	Pobierz listę wszystkich procesów, w tym systemowych i dziedziczonych.
getListsMetadata()	Zwraca metadane listy wyboru.
getProcessBehavior(string, string, GetBehaviorsExpand)	Zwraca zachowanie procesu.
getProcessBehaviors(string, GetBehaviorsExpand)	Zwraca listę wszystkich zachowań w procesie.
getProcessByItsId(string, GetProcessExpandLevel)	Pobierz pojedynczy proces o określonym identyfikatorze.
getProcessWorkItemType(string, string, GetWorkItemTypeExpand)	Zwraca pojedynczy typ elementu roboczego w procesie.
getProcessWorkItemTypeRule(string, string, string)	Zwraca pojedynczą regułę w typie elementu roboczego procesu.
getProcessWorkItemTypeRules(string, string)	Zwraca listę wszystkich reguł w typie elementu roboczego procesu.
getProcessWorkItemTypes(string, GetWorkItemTypeExpand)	Zwraca listę wszystkich typów elementów roboczych w procesie.
getStateDefinition(string, string, string)	Zwraca definicję pojedynczego stanu w typie elementu roboczego procesu.
getStateDefinitions(string, string)	Zwraca listę wszystkich definicji stanów w typie elementu roboczego procesu.
getSystemControls(string, string)	Pobiera edytowane kontrolki systemowe dla typu elementu roboczego w procesie. Aby uzyskać wszystkie kontrolki systemowe (podstawowe + edytowane), użyj interfejsów API układu
getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)	Zwraca pole w typie elementu roboczego.
hideStateDefinition(HideStateModel, string, string, string)	Ukrywa definicję stanu w typie elementu roboczego procesu. Tylko stany z customizationType:System mogą być ukryte.
moveControlToGroup(Control, string, string, string, string, string)	Przenosi formant do określonej grupy.
moveGroupToPage(Group, string, string, string, string, string, string, string)	Przenosi grupę na inną stronę i inną sekcję.
moveGroupToSection(Group, string, string, string, string, string, string)	Przenosi grupę do innej sekcji.
removeBehaviorFromWorkItemType(string, string, string)	Usuwa zachowanie dla typu elementu roboczego procesu.
removeControlFromGroup(string, string, string, string)	Usuwa kontrolkę z formularza elementu roboczego.
removeGroup(string, string, string, string, string)	Usuwa grupę z formularza elementu roboczego.
removePage(string, string, string)	Usuwa stronę z formularza elementu roboczego
removeWorkItemTypeField(string, string, string)	Usuwa pole z typu elementu roboczego. Nie usuwa pola na stałe.
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Aktualizuje zachowanie dla typu elementu roboczego procesu.
updateControl(Control, string, string, string, string)	Aktualizuje kontrolkę w formularzu elementu roboczego.
updateGroup(Group, string, string, string, string, string)	Aktualizuje grupę w formularzu elementu roboczego.
updateList(PickList, string)	Aktualizuje listę.
updatePage(Page, string, string)	Aktualizuje stronę w formularzu elementu roboczego
updateProcessBehavior(ProcessBehaviorUpdateRequest, string, string)	Zastępuje zachowanie w procesie.
updateProcessWorkItemType(UpdateProcessWorkItemTypeRequest, string, string)	Aktualizuje typ elementu roboczego procesu.
updateProcessWorkItemTypeRule(UpdateProcessRuleRequest, string, string, string)	Aktualizuje regułę w typie elementu roboczego procesu.
updateStateDefinition(WorkItemStateInputModel, string, string, string)	Aktualizuje daną definicję stanu w typie elementu roboczego procesu.
updateSystemControl(Control, string, string, string)	Aktualizuje/dodaje kontrolkę systemową w formularzu elementu roboczego.
updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)	Aktualizuje pole w typie elementu roboczego.

Szczegóły konstruktora

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

new WorkItemTrackingProcessRestClient(options: IVssRestClientOptions)

Parametry

options: IVssRestClientOptions

Szczegóły właściwości

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Wartość właściwości

string

Szczegóły metody

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Dodaje zachowanie do typu elementu roboczego procesu.

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

Parametry

behavior: WorkItemTypeBehavior

processId: string

Identyfikator procesu

witRefNameForBehaviors: string

Nazwa odwołania do typu elementu roboczego dla zachowania

Zwraca

Promise<WorkItemTypeBehavior>

addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)

Dodaje pole do typu elementu roboczego.

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

Parametry

field: AddProcessWorkItemTypeFieldRequest

processId: string

Identyfikator procesu.

witRefName: string

Nazwa odwołania typu elementu roboczego.

Zwraca

Promise<ProcessWorkItemTypeField>

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

Dodaje grupę do formularza elementu roboczego.

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

Parametry

group: Group

Grupa.

processId: string

Identyfikator procesu.

witRefName: string

Nazwa odwołania typu elementu roboczego.

pageId: string

Identyfikator strony, do której ma zostać dodana grupa.

sectionId: string

Identyfikator sekcji, do której ma zostać dodana grupa.

Zwraca

Promise<Group>

addPage(Page, string, string)

Dodaje stronę do formularza elementu roboczego.

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

Parametry

page: Page

Strona.

processId: string

Identyfikator procesu.

witRefName: string

Nazwa odwołania typu elementu roboczego.

Zwraca

Promise<Page>

addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)

Dodaje regułę do typu elementu roboczego w procesie.

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

Parametry

processRuleCreate: CreateProcessRuleRequest

processId: string

Identyfikator procesu

witRefName: string

Nazwa odwołania typu elementu roboczego

Zwraca

Promise<ProcessRule>

createControlInGroup(Control, string, string, string)

Tworzy formant w grupie.

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

Parametry

control: Control

Kontrola.

processId: string

Identyfikator procesu.

witRefName: string

Nazwa odwołania typu elementu roboczego.

groupId: string

Identyfikator grupy, do której ma zostać dodany formant.

Zwraca

Promise<Control>

createList(PickList)

Tworzy listę wyboru.

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

Parametry

picklist: PickList

Lista wyboru

Zwraca

Promise<PickList>

createNewProcess(CreateProcessModel)

Tworzy proces.

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

Parametry

createRequest: CreateProcessModel

CreateProcessModel.

Zwraca

Promise<ProcessInfo>

createProcessBehavior(ProcessBehaviorCreateRequest, string)

Tworzy pojedyncze zachowanie w danym procesie.

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

Parametry

behavior: ProcessBehaviorCreateRequest

processId: string

Identyfikator procesu

Zwraca

Promise<ProcessBehavior>

createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)

Tworzy typ elementu roboczego w procesie.

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

Parametry

workItemType: CreateProcessWorkItemTypeRequest

processId: string

Identyfikator procesu, w którym ma zostać utworzony typ elementu roboczego.

Zwraca

Promise<ProcessWorkItemType>

createStateDefinition(WorkItemStateInputModel, string, string)

Tworzy definicję stanu w typie elementu roboczego procesu.

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

Parametry

stateModel: WorkItemStateInputModel

processId: string

Identyfikator procesu

witRefName: string

Nazwa odwołania typu elementu roboczego

Zwraca

Promise<WorkItemStateResultModel>

deleteList(string)

Usuwa listę wyboru.

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

Parametry

listId: string

Identyfikator listy

Zwraca

Promise<void>

deleteProcessBehavior(string, string)

Usuwa zachowanie w procesie.

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

Parametry

processId: string

Identyfikator procesu

behaviorRefName: string

Nazwa odwołania do zachowania

Zwraca

Promise<void>

deleteProcessById(string)

Usuwa proces o określonym identyfikatorze.

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

Parametry

processTypeId: string

Zwraca

Promise<void>

deleteProcessWorkItemType(string, string)

Usuwa typ elementu roboczego w procesie.

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

Parametry

processId: string

Identyfikator procesu.

witRefName: string

Nazwa odwołania typu elementu roboczego.

Zwraca

Promise<void>

deleteProcessWorkItemTypeRule(string, string, string)

Usuwa regułę z typu elementu roboczego w procesie.

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

Parametry

processId: string

Identyfikator procesu

witRefName: string

Nazwa odwołania typu elementu roboczego

ruleId: string

Identyfikator reguły

Zwraca

Promise<void>

deleteStateDefinition(string, string, string)

Usuwa definicję stanu w typie elementu roboczego procesu.

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

Parametry

processId: string

Identyfikator procesu

witRefName: string

Nazwa odwołania typu elementu roboczego

stateId: string

Identyfikator stanu

Zwraca

Promise<void>

deleteSystemControl(string, string, string)

Usuwa modyfikację formantu systemu w formularzu elementu roboczego.

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

Parametry

processId: string

Identyfikator procesu.

witRefName: string

Nazwa odwołania typu elementu roboczego.

controlId: string

Identyfikator formantu.

Zwraca

Promise<Control[]>

editProcess(UpdateProcessModel, string)

Edytowanie procesu o określonym identyfikatorze.

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

Parametry

updateRequest: UpdateProcessModel

processTypeId: string

Zwraca

Promise<ProcessInfo>

getAllWorkItemTypeFields(string, string)

Zwraca listę wszystkich pól w typie elementu roboczego.

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

Parametry

processId: string

Identyfikator procesu.

witRefName: string

Nazwa odwołania typu elementu roboczego.

Zwraca

Promise<ProcessWorkItemTypeField[]>

getBehaviorForWorkItemType(string, string, string)

Zwraca zachowanie dla typu elementu roboczego procesu.

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

Parametry

processId: string

Identyfikator procesu

witRefNameForBehaviors: string

Nazwa odwołania do typu elementu roboczego dla zachowania

behaviorRefName: string

Nazwa odwołania do zachowania

Zwraca

Promise<WorkItemTypeBehavior>

getBehaviorsForWorkItemType(string, string)

Zwraca listę wszystkich zachowań dla typu elementu roboczego procesu.

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

Parametry

processId: string

Identyfikator procesu

witRefNameForBehaviors: string

Nazwa odwołania do typu elementu roboczego dla zachowania

Zwraca

Promise<WorkItemTypeBehavior[]>

getFormLayout(string, string)

Pobiera układ formularza.

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

Parametry

processId: string

Identyfikator procesu.

witRefName: string

Nazwa odwołania typu elementu roboczego.

Zwraca

Promise<FormLayout>

getList(string)

Zwraca listę wyboru.

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

Parametry

listId: string

Identyfikator listy

Zwraca

Promise<PickList>

getListOfProcesses(GetProcessExpandLevel)

Pobierz listę wszystkich procesów, w tym systemowych i dziedziczonych.

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

Parametry

expand: GetProcessExpandLevel

Zwraca

Promise<ProcessInfo[]>

getListsMetadata()

Zwraca metadane listy wyboru.

function getListsMetadata(): Promise<PickListMetadata[]>

Zwraca

Promise<PickListMetadata[]>

getProcessBehavior(string, string, GetBehaviorsExpand)

Zwraca zachowanie procesu.

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

Parametry

processId: string

Identyfikator procesu

behaviorRefName: string

Nazwa odwołania do zachowania

expand: GetBehaviorsExpand

Zwraca

Promise<ProcessBehavior>

getProcessBehaviors(string, GetBehaviorsExpand)

Zwraca listę wszystkich zachowań w procesie.

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

Parametry

processId: string

Identyfikator procesu

expand: GetBehaviorsExpand

Zwraca

Promise<ProcessBehavior[]>

getProcessByItsId(string, GetProcessExpandLevel)

Pobierz pojedynczy proces o określonym identyfikatorze.

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

Parametry

processTypeId: string

expand: GetProcessExpandLevel

Zwraca

Promise<ProcessInfo>

getProcessWorkItemType(string, string, GetWorkItemTypeExpand)

Zwraca pojedynczy typ elementu roboczego w procesie.

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

Parametry

processId: string

Identyfikator procesu

witRefName: string

Nazwa odwołania typu elementu roboczego

expand: GetWorkItemTypeExpand

Flaga określająca, jakie właściwości typu elementu roboczego mają zostać zwrócone

Zwraca

Promise<ProcessWorkItemType>

getProcessWorkItemTypeRule(string, string, string)

Zwraca pojedynczą regułę w typie elementu roboczego procesu.

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

Parametry

processId: string

Identyfikator procesu

witRefName: string

Nazwa odwołania typu elementu roboczego

ruleId: string

Identyfikator reguły

Zwraca

Promise<ProcessRule>

getProcessWorkItemTypeRules(string, string)

Zwraca listę wszystkich reguł w typie elementu roboczego procesu.

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

Parametry

processId: string

Identyfikator procesu

witRefName: string

Nazwa odwołania typu elementu roboczego

Zwraca

Promise<ProcessRule[]>

getProcessWorkItemTypes(string, GetWorkItemTypeExpand)

Zwraca listę wszystkich typów elementów roboczych w procesie.

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

Parametry

processId: string

Identyfikator procesu

expand: GetWorkItemTypeExpand

Flaga określająca, jakie właściwości typu elementu roboczego mają zostać zwrócone

Zwraca

Promise<ProcessWorkItemType[]>

getStateDefinition(string, string, string)

Zwraca definicję pojedynczego stanu w typie elementu roboczego procesu.

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

Parametry

processId: string

Identyfikator procesu

witRefName: string

Nazwa odwołania typu elementu roboczego

stateId: string

Identyfikator stanu

Zwraca

Promise<WorkItemStateResultModel>

getStateDefinitions(string, string)

Zwraca listę wszystkich definicji stanów w typie elementu roboczego procesu.

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

Parametry

processId: string

Identyfikator procesu

witRefName: string

Nazwa odwołania typu elementu roboczego

Zwraca

Promise<WorkItemStateResultModel[]>

getSystemControls(string, string)

Pobiera edytowane kontrolki systemowe dla typu elementu roboczego w procesie. Aby uzyskać wszystkie kontrolki systemowe (podstawowe + edytowane), użyj interfejsów API układu

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

Parametry

processId: string

Identyfikator procesu.

witRefName: string

Nazwa odwołania typu elementu roboczego.

Zwraca

Promise<Control[]>

getWorkItemTypeField(string, string, string, ProcessWorkItemTypeFieldsExpandLevel)

Zwraca pole w typie elementu roboczego.

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

Parametry

processId: string

Identyfikator procesu.

witRefName: string

Nazwa odwołania typu elementu roboczego.

fieldRefName: string

Nazwa odwołania do pola.

expand: ProcessWorkItemTypeFieldsExpandLevel

Zwraca

Promise<ProcessWorkItemTypeField>

hideStateDefinition(HideStateModel, string, string, string)

Ukrywa definicję stanu w typie elementu roboczego procesu. Tylko stany z customizationType:System mogą być ukryte.

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

Parametry

hideStateModel: HideStateModel

processId: string

Identyfikator procesu

witRefName: string

Nazwa odwołania typu elementu roboczego

stateId: string

Identyfikator stanu

Zwraca

Promise<WorkItemStateResultModel>

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

Przenosi formant do określonej grupy.

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

Parametry

control: Control

Kontrola.

processId: string

Identyfikator procesu.

witRefName: string

Nazwa odwołania typu elementu roboczego.

groupId: string

Identyfikator grupy, do której ma zostać przeniesiona kontrolka.

controlId: string

Identyfikator formantu.

removeFromGroupId: string

Identyfikator grupy, z której ma zostać usunięty formant.

Zwraca

Promise<Control>

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

Przenosi grupę na inną stronę i inną sekcję.

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

Parametry

group: Group

Zaktualizowana grupa.

processId: string

Identyfikator procesu.

witRefName: string

Nazwa odwołania typu elementu roboczego.

pageId: string

Identyfikator strony, na której znajduje się grupa.

sectionId: string

Identyfikator sekcji, w której grupa znajduje się i.n

groupId: string

Identyfikator grupy.

removeFromPageId: string

Identyfikator strony, z której chcesz usunąć grupę.

removeFromSectionId: string

Identyfikator sekcji, z której ma zostać usunięta grupa.

Zwraca

Promise<Group>

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

Przenosi grupę do innej sekcji.

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

Parametry

group: Group

Zaktualizowana grupa.

processId: string

Identyfikator procesu.

witRefName: string

Nazwa odwołania typu elementu roboczego.

pageId: string

Identyfikator strony, na której znajduje się grupa.

sectionId: string

Identyfikator sekcji, w której znajduje się grupa.

groupId: string

Identyfikator grupy.

removeFromSectionId: string

Identyfikator sekcji, z której ma zostać usunięta grupa.

Zwraca

Promise<Group>

removeBehaviorFromWorkItemType(string, string, string)

Usuwa zachowanie dla typu elementu roboczego procesu.

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

Parametry

processId: string

Identyfikator procesu

witRefNameForBehaviors: string

Nazwa odwołania do typu elementu roboczego dla zachowania

behaviorRefName: string

Nazwa odwołania do zachowania

Zwraca

Promise<void>

removeControlFromGroup(string, string, string, string)

Usuwa kontrolkę z formularza elementu roboczego.

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

Parametry

processId: string

Identyfikator procesu.

witRefName: string

Nazwa odwołania typu elementu roboczego.

groupId: string

Identyfikator grupy.

controlId: string

Identyfikator formantu do usunięcia.

Zwraca

Promise<void>

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

Usuwa grupę z formularza elementu roboczego.

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

Parametry

processId: string

Identyfikator procesu

witRefName: string

Nazwa odwołania typu elementu roboczego

pageId: string

Identyfikator strony, na której znajduje się grupa

sectionId: string

Identyfikator sekcji do grupy to w

groupId: string

Identyfikator grupy

Zwraca

Promise<void>

removePage(string, string, string)

Usuwa stronę z formularza elementu roboczego

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

Parametry

processId: string

Identyfikator procesu

witRefName: string

Nazwa odwołania typu elementu roboczego

pageId: string

Identyfikator strony

Zwraca

Promise<void>

removeWorkItemTypeField(string, string, string)

Usuwa pole z typu elementu roboczego. Nie usuwa pola na stałe.

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

Parametry

processId: string

Identyfikator procesu.

witRefName: string

Nazwa odwołania typu elementu roboczego.

fieldRefName: string

Nazwa odwołania do pola.

Zwraca

Promise<void>

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Aktualizuje zachowanie dla typu elementu roboczego procesu.

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

Parametry

behavior: WorkItemTypeBehavior

processId: string

Identyfikator procesu

witRefNameForBehaviors: string

Nazwa odwołania do typu elementu roboczego dla zachowania

Zwraca

Promise<WorkItemTypeBehavior>

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

Aktualizuje kontrolkę w formularzu elementu roboczego.

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

Parametry

control: Control

Zaktualizowana kontrolka.

processId: string

Identyfikator procesu.

witRefName: string

Nazwa odwołania typu elementu roboczego.

groupId: string

Identyfikator grupy.

controlId: string

Identyfikator formantu.

Zwraca

Promise<Control>

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

Aktualizuje grupę w formularzu elementu roboczego.

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

Parametry

group: Group

Zaktualizowana grupa.

processId: string

Identyfikator procesu.

witRefName: string

Nazwa odwołania typu elementu roboczego.

pageId: string

Identyfikator strony, na której znajduje się grupa.

sectionId: string

Identyfikator sekcji, w której znajduje się grupa.

groupId: string

Identyfikator grupy.

Zwraca

Promise<Group>

updateList(PickList, string)

Aktualizuje listę.

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

Parametry

picklist: PickList

listId: string

Identyfikator listy

Zwraca

Promise<PickList>

updatePage(Page, string, string)

Aktualizuje stronę w formularzu elementu roboczego

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

Parametry

page: Page

Strona

processId: string

Identyfikator procesu

witRefName: string

Nazwa odwołania typu elementu roboczego

Zwraca

Promise<Page>

updateProcessBehavior(ProcessBehaviorUpdateRequest, string, string)

Zastępuje zachowanie w procesie.

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

Parametry

behaviorData: ProcessBehaviorUpdateRequest

processId: string

Identyfikator procesu

behaviorRefName: string

Nazwa odwołania do zachowania

Zwraca

Promise<ProcessBehavior>

updateProcessWorkItemType(UpdateProcessWorkItemTypeRequest, string, string)

Aktualizuje typ elementu roboczego procesu.

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

Parametry

workItemTypeUpdate: UpdateProcessWorkItemTypeRequest

processId: string

Identyfikator procesu

witRefName: string

Nazwa odwołania typu elementu roboczego

Zwraca

Promise<ProcessWorkItemType>

updateProcessWorkItemTypeRule(UpdateProcessRuleRequest, string, string, string)

Aktualizuje regułę w typie elementu roboczego procesu.

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

Parametry

processRule: UpdateProcessRuleRequest

processId: string

Identyfikator procesu

witRefName: string

Nazwa odwołania typu elementu roboczego

ruleId: string

Identyfikator reguły

Zwraca

Promise<ProcessRule>

updateStateDefinition(WorkItemStateInputModel, string, string, string)

Aktualizuje daną definicję stanu w typie elementu roboczego procesu.

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

Parametry

stateModel: WorkItemStateInputModel

processId: string

Identyfikator procesu

witRefName: string

Nazwa odwołania typu elementu roboczego

stateId: string

Identyfikator stanu

Zwraca

Promise<WorkItemStateResultModel>

updateSystemControl(Control, string, string, string)

Aktualizuje/dodaje kontrolkę systemową w formularzu elementu roboczego.

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

Parametry

control: Control

processId: string

Identyfikator procesu.

witRefName: string

Nazwa odwołania typu elementu roboczego.

controlId: string

Identyfikator formantu.

Zwraca

Promise<Control>

updateWorkItemTypeField(UpdateProcessWorkItemTypeFieldRequest, string, string, string)

Aktualizuje pole w typie elementu roboczego.

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

Parametry

field: UpdateProcessWorkItemTypeFieldRequest

processId: string

Identyfikator procesu.

witRefName: string

Nazwa odwołania typu elementu roboczego.

fieldRefName: string

Nazwa odwołania do pola.

Zwraca

Promise<ProcessWorkItemTypeField>

Sprzężenie zwrotne

Czy ta strona była pomocna?

Udostępnij za pomocą

WorkItemTrackingProcessRestClient class

Konstruktory

Właściwości

Metody

Szczegóły konstruktora

WorkItemTrackingProcessRestClient(IVssRestClientOptions)

Parametry

Szczegóły właściwości

RESOURCE_AREA_ID

Wartość właściwości

Szczegóły metody

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Parametry

Zwraca

addFieldToWorkItemType(AddProcessWorkItemTypeFieldRequest, string, string)

Parametry

Zwraca

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

Parametry

Zwraca

addPage(Page, string, string)

Parametry

Zwraca

addProcessWorkItemTypeRule(CreateProcessRuleRequest, string, string)

Parametry

Zwraca

createControlInGroup(Control, string, string, string)

Parametry

Zwraca

createList(PickList)

Parametry

Zwraca

createNewProcess(CreateProcessModel)

Parametry

Zwraca

createProcessBehavior(ProcessBehaviorCreateRequest, string)

Parametry

Zwraca

createProcessWorkItemType(CreateProcessWorkItemTypeRequest, string)

Parametry

Zwraca

createStateDefinition(WorkItemStateInputModel, string, string)

Parametry

Zwraca

deleteList(string)

Parametry

Zwraca

deleteProcessBehavior(string, string)

Parametry

Zwraca

deleteProcessById(string)

Parametry

Zwraca

deleteProcessWorkItemType(string, string)

Parametry

Zwraca

deleteProcessWorkItemTypeRule(string, string, string)

Parametry

Zwraca

deleteStateDefinition(string, string, string)

Parametry

Zwraca

deleteSystemControl(string, string, string)

Parametry

Zwraca

editProcess(UpdateProcessModel, string)

Parametry

Zwraca

getAllWorkItemTypeFields(string, string)

Parametry

Zwraca

getBehaviorForWorkItemType(string, string, string)

Parametry

Zwraca

getBehaviorsForWorkItemType(string, string)

Parametry

Zwraca

getFormLayout(string, string)

Parametry