WorkItemTrackingProcessDefinitionsRestClient 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

Extends

RestClientBase

Konstruktory

WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)

Właściwości

RESOURCE_AREA_ID

Metody

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Dodaje zachowanie do typu elementu roboczego procesu.
addControlToGroup(Control, string, string, string)	Tworzy kontrolkę w grupie
addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)	Dodaje pole do typu elementu roboczego w procesie.
addGroup(Group, string, string, string, string)	Dodaje grupę do formularza elementu roboczego
addPage(Page, string, string)	Dodaje stronę do formularza elementu roboczego
createBehavior(BehaviorCreateModel, string)	Tworzy pojedyncze zachowanie w danym procesie.
createField(FieldModel, string)	Tworzy jedno pole w procesie.
createList(PickListModel)	Tworzy listę wyboru.
createStateDefinition(WorkItemStateInputModel, string, string)	Tworzy definicję stanu w typie elementu roboczego procesu.
createWorkItemType(WorkItemTypeModel, string)	Tworzy typ elementu roboczego w procesie.
deleteBehavior(string, string)	Usuwa zachowanie w procesie.
deleteList(string)	Usuwa listę wyboru.
deleteStateDefinition(string, string, string)	Usuwa definicję stanu w typie elementu roboczego procesu.
deleteWorkItemType(string, string)	Usuwa typ elementu roboczego w procesie.
editControl(Control, string, string, string, string)	Aktualizacje kontrolkę w formularzu elementu roboczego
editGroup(Group, string, string, string, string, string)	Aktualizacje grupę w formularzu elementu roboczego
editPage(Page, string, string)	Aktualizacje stronę w formularzu elementu roboczego
getBehavior(string, string)	Zwraca pojedyncze zachowanie w procesie.
getBehaviorForWorkItemType(string, string, string)	Zwraca zachowanie typu elementu roboczego procesu.
getBehaviors(string)	Zwraca listę wszystkich zachowań w procesie.
getBehaviorsForWorkItemType(string, string)	Zwraca listę wszystkich zachowań dla typu elementu roboczego procesu.
getFormLayout(string, string)	Pobiera układ formularza
getList(string)	Zwraca listę wyboru.
getListsMetadata()	Zwraca metadane z listy wyboru.
getStateDefinition(string, string, string)	Zwraca definicję stanu w typie elementu roboczego procesu.
getStateDefinitions(string, string)	Zwraca listę wszystkich definicji stanu w typie elementu roboczego procesu.
getWorkItemType(string, string, GetWorkItemTypeExpand)	Zwraca typ elementu roboczego procesu.
getWorkItemTypeField(string, string, string)	Zwraca pojedyncze pole w typie elementu roboczego procesu.
getWorkItemTypeFields(string, string)	Zwraca listę wszystkich pól w typie elementu roboczego procesu.
getWorkItemTypes(string, GetWorkItemTypeExpand)	Zwraca listę wszystkich typów elementów roboczych w procesie.
hideStateDefinition(HideStateModel, string, string, string)	Ukrywa definicję stanu w typie elementu roboczego procesu.
removeBehaviorFromWorkItemType(string, string, string)	Usuwa zachowanie typu elementu roboczego procesu.
removeControlFromGroup(string, string, string, string)	Usuwa kontrolkę z formularza elementu roboczego
removeFieldFromWorkItemType(string, string, string)	Usuwa pole w typie elementu roboczego procesu.
removeGroup(string, string, string, string, string)	Usuwa grupę z formularza elementu roboczego
removePage(string, string, string)	Usuwa stronę z formularza elementu roboczego
replaceBehavior(BehaviorReplaceModel, string, string)	Zastępuje zachowanie w procesie.
setControlInGroup(Control, string, string, string, string, string)	Przenosi kontrolkę do nowej grupy
setGroupInPage(Group, string, string, string, string, string, string, string)	Przenosi grupę na inną stronę i sekcję
setGroupInSection(Group, string, string, string, string, string, string)	Przenosi grupę do innej sekcji
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Aktualizacje domyślny typ elementu roboczego dla zachowania procesu.
updateField(FieldUpdate, string)	Aktualizacje danego pola w procesie.
updateList(PickListModel, string)	Aktualizacje listę.
updateStateDefinition(WorkItemStateInputModel, string, string, string)	Aktualizacje daną definicję stanu w typie elementu roboczego procesu.
updateWorkItemType(WorkItemTypeUpdateModel, string, string)	Aktualizacje typ elementu roboczego procesu.
updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)	Aktualizacje pojedyncze pole w zakresie danego procesu i typu elementu roboczego.

Szczegóły konstruktora

WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)

new WorkItemTrackingProcessDefinitionsRestClient(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 referencyjna typu elementu roboczego dla zachowania

Zwraca

Promise<WorkItemTypeBehavior>

addControlToGroup(Control, string, string, string)

Tworzy kontrolkę w grupie

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

Parametry

control

Control

Kontrolka

processId

string

Identyfikator procesu

witRefName

string

Nazwa odwołania typu elementu roboczego

groupId

string

Identyfikator grupy w celu dodania kontrolki do

Zwraca

Promise<Control>

addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)

Dodaje pole do typu elementu roboczego w procesie.

function addFieldToWorkItemType(field: WorkItemTypeFieldModel2, processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2>

Parametry

field

WorkItemTypeFieldModel2

processId

string

Identyfikator procesu

witRefNameForFields

string

Nazwa odwołania do typu elementu roboczego dla pola

Zwraca

Promise<WorkItemTypeFieldModel2>

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órych ma zostać dodana grupa

sectionId

string

Identyfikator sekcji, do których 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>

createBehavior(BehaviorCreateModel, string)

Tworzy pojedyncze zachowanie w danym procesie.

function createBehavior(behavior: BehaviorCreateModel, processId: string): Promise<BehaviorModel>

Parametry

behavior

BehaviorCreateModel

processId

string

Identyfikator procesu

Zwraca

Promise<BehaviorModel>

createField(FieldModel, string)

Tworzy jedno pole w procesie.

function createField(field: FieldModel, processId: string): Promise<FieldModel>

Parametry

field

FieldModel

processId

string

Identyfikator procesu

Zwraca

Promise<FieldModel>

createList(PickListModel)

Tworzy listę wyboru.

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

Parametry

picklist

PickListModel

Zwraca

Promise<PickListModel>

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>

createWorkItemType(WorkItemTypeModel, string)

Tworzy typ elementu roboczego w procesie.

function createWorkItemType(workItemType: WorkItemTypeModel, processId: string): Promise<WorkItemTypeModel>

Parametry

workItemType

WorkItemTypeModel

processId

string

Identyfikator procesu

Zwraca

Promise<WorkItemTypeModel>

deleteBehavior(string, string)

Usuwa zachowanie w procesie.

function deleteBehavior(processId: string, behaviorId: string): Promise<void>

Parametry

processId

string

Identyfikator procesu

behaviorId

string

Identyfikator zachowania

Zwraca

Promise<void>

deleteList(string)

Usuwa listę wyboru.

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

Parametry

listId

string

Identyfikator listy

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>

deleteWorkItemType(string, string)

Usuwa typ elementu roboczego w procesie.

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

Parametry

processId

string

Identyfikator procesu

witRefName

string

Nazwa odwołania typu elementu roboczego

Zwraca

Promise<void>

editControl(Control, string, string, string, string)

Aktualizacje kontrolkę w formularzu elementu roboczego

function editControl(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 kontrolki

Zwraca

Promise<Control>

editGroup(Group, string, string, string, string, string)

Aktualizacje grupę w formularzu elementu roboczego

function editGroup(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, w których znajduje się grupa

sectionId

string

Identyfikator sekcji, w których znajduje się grupa

groupId

string

Identyfikator grupy

Zwraca

Promise<Group>

editPage(Page, string, string)

Aktualizacje stronę w formularzu elementu roboczego

function editPage(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>

getBehavior(string, string)

Zwraca pojedyncze zachowanie w procesie.

function getBehavior(processId: string, behaviorId: string): Promise<BehaviorModel>

Parametry

processId

string

Identyfikator procesu

behaviorId

string

Identyfikator zachowania

Zwraca

Promise<BehaviorModel>

getBehaviorForWorkItemType(string, string, string)

Zwraca zachowanie 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>

getBehaviors(string)

Zwraca listę wszystkich zachowań w procesie.

function getBehaviors(processId: string): Promise<BehaviorModel[]>

Parametry

processId

string

Identyfikator procesu

Zwraca

Promise<BehaviorModel[]>

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<PickListModel>

Parametry

listId

string

Identyfikator listy

Zwraca

Promise<PickListModel>

getListsMetadata()

Zwraca metadane z listy wyboru.

function getListsMetadata(): Promise<PickListMetadataModel[]>

Zwraca

Promise<PickListMetadataModel[]>

getStateDefinition(string, string, string)

Zwraca definicję 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 stanu 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[]>

getWorkItemType(string, string, GetWorkItemTypeExpand)

Zwraca typ elementu roboczego procesu.

function getWorkItemType(processId: string, witRefName: string, expand?: GetWorkItemTypeExpand): Promise<WorkItemTypeModel>

Parametry

processId

string

Identyfikator procesu

witRefName

string

Nazwa odwołania typu elementu roboczego

expand

GetWorkItemTypeExpand

Zwraca

Promise<WorkItemTypeModel>

getWorkItemTypeField(string, string, string)

Zwraca pojedyncze pole w typie elementu roboczego procesu.

function getWorkItemTypeField(processId: string, witRefNameForFields: string, fieldRefName: string): Promise<WorkItemTypeFieldModel2>

Parametry

processId

string

Identyfikator procesu

witRefNameForFields

string

Nazwa odwołania typu elementu roboczego dla pól

fieldRefName

string

Nazwa odwołania do pola

Zwraca

Promise<WorkItemTypeFieldModel2>

getWorkItemTypeFields(string, string)

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

function getWorkItemTypeFields(processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2[]>

Parametry

processId

string

Identyfikator procesu

witRefNameForFields

string

Nazwa odwołania typu elementu roboczego dla pól

Zwraca

Promise<WorkItemTypeFieldModel2[]>

getWorkItemTypes(string, GetWorkItemTypeExpand)

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

function getWorkItemTypes(processId: string, expand?: GetWorkItemTypeExpand): Promise<WorkItemTypeModel[]>

Parametry

processId

string

Identyfikator procesu

expand

GetWorkItemTypeExpand

Zwraca

Promise<WorkItemTypeModel[]>

hideStateDefinition(HideStateModel, string, string, string)

Ukrywa definicję stanu w typie elementu roboczego procesu.

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>

removeBehaviorFromWorkItemType(string, string, string)

Usuwa zachowanie 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 kontrolki do usunięcia

Zwraca

Promise<void>

removeFieldFromWorkItemType(string, string, string)

Usuwa pole w typie elementu roboczego procesu.

function removeFieldFromWorkItemType(processId: string, witRefNameForFields: string, fieldRefName: string): Promise<void>

Parametry

processId

string

Identyfikator procesu

witRefNameForFields

string

Nazwa odwołania typu elementu roboczego dla pól

fieldRefName

string

Nazwa odwołania do pola

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, w których znajduje się grupa

sectionId

string

Identyfikator sekcji grupy znajduje się 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>

replaceBehavior(BehaviorReplaceModel, string, string)

Zastępuje zachowanie w procesie.

function replaceBehavior(behaviorData: BehaviorReplaceModel, processId: string, behaviorId: string): Promise<BehaviorModel>

Parametry

behaviorData

BehaviorReplaceModel

processId

string

Identyfikator procesu

behaviorId

string

Identyfikator zachowania

Zwraca

Promise<BehaviorModel>

setControlInGroup(Control, string, string, string, string, string)

Przenosi kontrolkę do nowej grupy

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

Parametry

control

Control

Kontrolka

processId

string

Identyfikator procesu

witRefName

string

Nazwa odwołania typu elementu roboczego

groupId

string

Identyfikator grupy do przeniesienia kontrolki do

controlId

string

Identyfikator kontrolki

removeFromGroupId

string

Grupa do usunięcia kontrolki z

Zwraca

Promise<Control>

setGroupInPage(Group, string, string, string, string, string, string, string)

Przenosi grupę na inną stronę i sekcję

function setGroupInPage(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, w których znajduje się grupa

sectionId

string

Identyfikator sekcji, w których znajduje się grupa

groupId

string

Identyfikator grupy

removeFromPageId

string

Identyfikator strony do usunięcia grupy z

removeFromSectionId

string

Identyfikator sekcji w celu usunięcia grupy z

Zwraca

Promise<Group>

setGroupInSection(Group, string, string, string, string, string, string)

Przenosi grupę do innej sekcji

function setGroupInSection(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, w których znajduje się grupa

sectionId

string

Identyfikator sekcji, w których znajduje się grupa

groupId

string

Identyfikator grupy

removeFromSectionId

string

Identyfikator sekcji w celu usunięcia grupy z

Zwraca

Promise<Group>

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Aktualizacje domyślny typ elementu roboczego dla zachowania 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>

updateField(FieldUpdate, string)

Aktualizacje danego pola w procesie.

function updateField(field: FieldUpdate, processId: string): Promise<FieldModel>

Parametry

field

FieldUpdate

processId

string

Identyfikator procesu

Zwraca

Promise<FieldModel>

updateList(PickListModel, string)

Aktualizacje listę.

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

Parametry

picklist

PickListModel

listId

string

Identyfikator listy

Zwraca

Promise<PickListModel>

updateStateDefinition(WorkItemStateInputModel, string, string, string)

Aktualizacje 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>

updateWorkItemType(WorkItemTypeUpdateModel, string, string)

Aktualizacje typ elementu roboczego procesu.

function updateWorkItemType(workItemTypeUpdate: WorkItemTypeUpdateModel, processId: string, witRefName: string): Promise<WorkItemTypeModel>

Parametry

workItemTypeUpdate

WorkItemTypeUpdateModel

processId

string

Identyfikator procesu

witRefName

string

Nazwa odwołania typu elementu roboczego

Zwraca

Promise<WorkItemTypeModel>

updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)

Aktualizacje pojedyncze pole w zakresie danego procesu i typu elementu roboczego.

function updateWorkItemTypeField(field: WorkItemTypeFieldModel2, processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2>

Parametry

field

WorkItemTypeFieldModel2

Model, za pomocą którego należy zaktualizować pole

processId

string

Identyfikator procesu

witRefNameForFields

string

Nazwa odwołania typu elementu roboczego dla pól

Zwraca

Promise<WorkItemTypeFieldModel2>