WorkItemTrackingProcessDefinitionsRestClient class

Balíček:

azure-devops-extension-api

Základní třída, která by se měla použít (odvozená) k provádění požadavků na rozhraní REST API služby VSS

Extends

RestClientBase

Konstruktory

WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)

Vlastnosti

RESOURCE_AREA_ID

Metody

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Přidá chování k typu pracovní položky procesu.
addControlToGroup(Control, string, string, string)	Vytvoří ovládací prvek ve skupině.
addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)	Přidá pole do typu pracovní položky v procesu.
addGroup(Group, string, string, string, string)	Přidá skupinu do formuláře pracovní položky.
addPage(Page, string, string)	Přidá stránku do formuláře pracovní položky.
createBehavior(BehaviorCreateModel, string)	Vytvoří v daném procesu jedno chování.
createField(FieldModel, string)	Vytvoří v procesu jedno pole.
createList(PickListModel)	Vytvoří rozevírací seznam.
createStateDefinition(WorkItemStateInputModel, string, string)	Vytvoří definici stavu v typu pracovní položky procesu.
createWorkItemType(WorkItemTypeModel, string)	Vytvoří v procesu typ pracovní položky.
deleteBehavior(string, string)	Odebere chování v procesu.
deleteList(string)	Odebere rozevírací seznam.
deleteStateDefinition(string, string, string)	Odebere definici stavu v typu pracovní položky procesu.
deleteWorkItemType(string, string)	Odebere typ pracovní položky v procesu.
editControl(Control, string, string, string, string)	Aktualizuje ovládací prvek ve formuláři pracovní položky.
editGroup(Group, string, string, string, string, string)	Aktualizuje skupinu ve formuláři pracovní položky.
editPage(Page, string, string)	Aktualizuje stránku ve formuláři pracovní položky.
getBehavior(string, string)	Vrátí jedno chování v procesu.
getBehaviorForWorkItemType(string, string, string)	Vrátí chování pro typ pracovní položky procesu.
getBehaviors(string)	Vrátí seznam všech chování v procesu.
getBehaviorsForWorkItemType(string, string)	Vrátí seznam všech chování pro typ pracovní položky procesu.
getFormLayout(string, string)	Získá rozložení formuláře.
getList(string)	Vrátí rozevírací seznam.
getListsMetadata()	Vrátí meta data rozevíracího seznamu.
getStateDefinition(string, string, string)	Vrátí definici stavu v typu pracovní položky procesu.
getStateDefinitions(string, string)	Vrátí seznam všech definic stavů v typu pracovní položky procesu.
getWorkItemType(string, string, GetWorkItemTypeExpand)	Vrátí typ pracovní položky procesu.
getWorkItemTypeField(string, string, string)	Vrátí jedno pole v typu pracovní položky procesu.
getWorkItemTypeFields(string, string)	Vrátí seznam všech polí v typu pracovní položky procesu.
getWorkItemTypes(string, GetWorkItemTypeExpand)	Vrátí seznam všech typů pracovních položek v procesu.
hideStateDefinition(HideStateModel, string, string, string)	Skryje definici stavu v typu pracovní položky procesu.
removeBehaviorFromWorkItemType(string, string, string)	Odebere chování typu pracovní položky procesu.
removeControlFromGroup(string, string, string, string)	Odebere ovládací prvek z formuláře pracovní položky.
removeFieldFromWorkItemType(string, string, string)	Odebere pole v typu pracovní položky procesu.
removeGroup(string, string, string, string, string)	Odebere skupinu z formuláře pracovní položky.
removePage(string, string, string)	Odebere stránku z formuláře pracovní položky.
replaceBehavior(BehaviorReplaceModel, string, string)	Nahradí chování v procesu.
setControlInGroup(Control, string, string, string, string, string)	Přesune ovládací prvek do nové skupiny.
setGroupInPage(Group, string, string, string, string, string, string, string)	Přesune skupinu na jinou stránku a oddíl.
setGroupInSection(Group, string, string, string, string, string, string)	Přesune skupinu do jiného oddílu.
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Aktualizuje výchozí typ pracovní položky pro chování procesu.
updateField(FieldUpdate, string)	Aktualizuje dané pole v procesu.
updateList(PickListModel, string)	Aktualizuje seznam.
updateStateDefinition(WorkItemStateInputModel, string, string, string)	Aktualizuje danou definici stavu v typu pracovní položky procesu.
updateWorkItemType(WorkItemTypeUpdateModel, string, string)	Aktualizuje typ pracovní položky procesu.
updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)	Aktualizuje jedno pole v oboru daného procesu a typu pracovní položky.

Podrobnosti konstruktoru

WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)

new WorkItemTrackingProcessDefinitionsRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Podrobnosti vlastnosti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Hodnota vlastnosti

string

Podrobnosti metody

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Přidá chování k typu pracovní položky procesu.

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

Parametry

behavior

WorkItemTypeBehavior

processId

string

ID procesu

witRefNameForBehaviors

string

Název odkazu na typ pracovní položky pro chování

Návraty

Promise<WorkItemTypeBehavior>

addControlToGroup(Control, string, string, string)

Vytvoří ovládací prvek ve skupině.

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

Parametry

control

Control

Ovládací prvek

processId

string

ID procesu

witRefName

string

Název odkazu typu pracovní položky

groupId

string

ID skupiny pro přidání ovládacího prvku do

Návraty

Promise<Control>

addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)

Přidá pole do typu pracovní položky v procesu.

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

Parametry

field

WorkItemTypeFieldModel2

processId

string

ID procesu

witRefNameForFields

string

Název odkazu typu pracovní položky pro pole

Návraty

Promise<WorkItemTypeFieldModel2>

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

Přidá skupinu do formuláře pracovní položky.

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

Parametry

group

Group

Skupina

processId

string

ID procesu

witRefName

string

Název odkazu typu pracovní položky

pageId

string

ID stránky pro přidání skupiny do

sectionId

string

ID oddílu pro přidání skupiny do

Návraty

Promise<Group>

addPage(Page, string, string)

Přidá stránku do formuláře pracovní položky.

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

Parametry

page

Page

Stránka

processId

string

ID procesu

witRefName

string

Název odkazu typu pracovní položky

Návraty

Promise<Page>

createBehavior(BehaviorCreateModel, string)

Vytvoří v daném procesu jedno chování.

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

Parametry

behavior

BehaviorCreateModel

processId

string

ID procesu

Návraty

Promise<BehaviorModel>

createField(FieldModel, string)

Vytvoří v procesu jedno pole.

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

Parametry

field

FieldModel

processId

string

ID procesu

Návraty

Promise<FieldModel>

createList(PickListModel)

Vytvoří rozevírací seznam.

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

Parametry

picklist

PickListModel

Návraty

Promise<PickListModel>

createStateDefinition(WorkItemStateInputModel, string, string)

Vytvoří definici stavu v typu pracovní položky procesu.

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

Parametry

stateModel

WorkItemStateInputModel

processId

string

ID procesu

witRefName

string

Název odkazu typu pracovní položky

Návraty

Promise<WorkItemStateResultModel>

createWorkItemType(WorkItemTypeModel, string)

Vytvoří v procesu typ pracovní položky.

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

Parametry

workItemType

WorkItemTypeModel

processId

string

ID procesu

Návraty

Promise<WorkItemTypeModel>

deleteBehavior(string, string)

Odebere chování v procesu.

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

Parametry

processId

string

ID procesu

behaviorId

string

ID chování

Návraty

Promise<void>

deleteList(string)

Odebere rozevírací seznam.

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

Parametry

listId

string

ID seznamu

Návraty

Promise<void>

deleteStateDefinition(string, string, string)

Odebere definici stavu v typu pracovní položky procesu.

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

Parametry

processId

string

ID procesu

witRefName

string

Název odkazu typu pracovní položky

stateId

string

ID stavu

Návraty

Promise<void>

deleteWorkItemType(string, string)

Odebere typ pracovní položky v procesu.

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

Parametry

processId

string

ID procesu

witRefName

string

Název odkazu typu pracovní položky

Návraty

Promise<void>

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

Aktualizuje ovládací prvek ve formuláři pracovní položky.

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

Parametry

control

Control

Aktualizovaný ovládací prvek

processId

string

ID procesu

witRefName

string

Název odkazu typu pracovní položky

groupId

string

ID skupiny

controlId

string

ID ovládacího prvku

Návraty

Promise<Control>

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

Aktualizuje skupinu ve formuláři pracovní položky.

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

Parametry

group

Group

Aktualizovaná skupina

processId

string

ID procesu

witRefName

string

Název odkazu typu pracovní položky

pageId

string

ID stránky, ve které je skupina

sectionId

string

ID oddílu, ve které je skupina

groupId

string

ID skupiny

Návraty

Promise<Group>

editPage(Page, string, string)

Aktualizuje stránku ve formuláři pracovní položky.

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

Parametry

page

Page

Stránka

processId

string

ID procesu

witRefName

string

Název odkazu typu pracovní položky

Návraty

Promise<Page>

getBehavior(string, string)

Vrátí jedno chování v procesu.

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

Parametry

processId

string

ID procesu

behaviorId

string

ID chování

Návraty

Promise<BehaviorModel>

getBehaviorForWorkItemType(string, string, string)

Vrátí chování pro typ pracovní položky procesu.

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

Parametry

processId

string

ID procesu

witRefNameForBehaviors

string

Název odkazu na typ pracovní položky pro chování

behaviorRefName

string

Název odkazu chování

Návraty

Promise<WorkItemTypeBehavior>

getBehaviors(string)

Vrátí seznam všech chování v procesu.

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

Parametry

processId

string

ID procesu

Návraty

Promise<BehaviorModel[]>

getBehaviorsForWorkItemType(string, string)

Vrátí seznam všech chování pro typ pracovní položky procesu.

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

Parametry

processId

string

ID procesu

witRefNameForBehaviors

string

Název odkazu na typ pracovní položky pro chování

Návraty

Promise<WorkItemTypeBehavior[]>

getFormLayout(string, string)

Získá rozložení formuláře.

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

Parametry

processId

string

ID procesu

witRefName

string

Název odkazu typu pracovní položky

Návraty

Promise<FormLayout>

getList(string)

Vrátí rozevírací seznam.

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

Parametry

listId

string

ID seznamu

Návraty

Promise<PickListModel>

getListsMetadata()

Vrátí meta data rozevíracího seznamu.

function getListsMetadata(): Promise<PickListMetadataModel[]>

Návraty

Promise<PickListMetadataModel[]>

getStateDefinition(string, string, string)

Vrátí definici stavu v typu pracovní položky procesu.

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

Parametry

processId

string

ID procesu

witRefName

string

Název odkazu typu pracovní položky

stateId

string

ID stavu

Návraty

Promise<WorkItemStateResultModel>

getStateDefinitions(string, string)

Vrátí seznam všech definic stavů v typu pracovní položky procesu.

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

Parametry

processId

string

ID procesu

witRefName

string

Název odkazu typu pracovní položky

Návraty

Promise<WorkItemStateResultModel[]>

getWorkItemType(string, string, GetWorkItemTypeExpand)

Vrátí typ pracovní položky procesu.

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

Parametry

processId

string

ID procesu

witRefName

string

Název odkazu typu pracovní položky

expand

GetWorkItemTypeExpand

Návraty

Promise<WorkItemTypeModel>

getWorkItemTypeField(string, string, string)

Vrátí jedno pole v typu pracovní položky procesu.

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

Parametry

processId

string

ID procesu

witRefNameForFields

string

Referenční název typu pracovní položky pro pole

fieldRefName

string

Název odkazu pole

Návraty

Promise<WorkItemTypeFieldModel2>

getWorkItemTypeFields(string, string)

Vrátí seznam všech polí v typu pracovní položky procesu.

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

Parametry

processId

string

ID procesu

witRefNameForFields

string

Referenční název typu pracovní položky pro pole

Návraty

Promise<WorkItemTypeFieldModel2[]>

getWorkItemTypes(string, GetWorkItemTypeExpand)

Vrátí seznam všech typů pracovních položek v procesu.

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

Parametry

processId

string

ID procesu

expand

GetWorkItemTypeExpand

Návraty

Promise<WorkItemTypeModel[]>

hideStateDefinition(HideStateModel, string, string, string)

Skryje definici stavu v typu pracovní položky procesu.

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

Parametry

hideStateModel

HideStateModel

processId

string

ID procesu

witRefName

string

Název odkazu typu pracovní položky

stateId

string

ID stavu

Návraty

Promise<WorkItemStateResultModel>

removeBehaviorFromWorkItemType(string, string, string)

Odebere chování typu pracovní položky procesu.

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

Parametry

processId

string

ID procesu

witRefNameForBehaviors

string

Název odkazu na typ pracovní položky pro chování

behaviorRefName

string

Název odkazu chování

Návraty

Promise<void>

removeControlFromGroup(string, string, string, string)

Odebere ovládací prvek z formuláře pracovní položky.

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

Parametry

processId

string

ID procesu

witRefName

string

Název odkazu typu pracovní položky

groupId

string

ID skupiny

controlId

string

ID ovládacího prvku, který chcete odebrat

Návraty

Promise<void>

removeFieldFromWorkItemType(string, string, string)

Odebere pole v typu pracovní položky procesu.

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

Parametry

processId

string

ID procesu

witRefNameForFields

string

Referenční název typu pracovní položky pro pole

fieldRefName

string

Název odkazu pole

Návraty

Promise<void>

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

Odebere skupinu z formuláře pracovní položky.

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

Parametry

processId

string

ID procesu

witRefName

string

Název odkazu typu pracovní položky

pageId

string

ID stránky, ve které je skupina

sectionId

string

ID oddílu skupiny je v

groupId

string

ID skupiny

Návraty

Promise<void>

removePage(string, string, string)

Odebere stránku z formuláře pracovní položky.

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

Parametry

processId

string

ID procesu

witRefName

string

Název odkazu typu pracovní položky

pageId

string

ID stránky

Návraty

Promise<void>

replaceBehavior(BehaviorReplaceModel, string, string)

Nahradí chování v procesu.

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

Parametry

behaviorData

BehaviorReplaceModel

processId

string

ID procesu

behaviorId

string

ID chování

Návraty

Promise<BehaviorModel>

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

Přesune ovládací prvek do nové skupiny.

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

Parametry

control

Control

Ovládací prvek

processId

string

ID procesu

witRefName

string

Název odkazu typu pracovní položky

groupId

string

ID skupiny pro přesunutí ovládacího prvku do

controlId

string

ID ovládacího prvku

removeFromGroupId

string

Skupina, ze které chcete ovládací prvek odebrat

Návraty

Promise<Control>

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

Přesune skupinu na jinou stránku a oddíl.

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

Parametry

group

Group

Aktualizovaná skupina

processId

string

ID procesu

witRefName

string

Název odkazu typu pracovní položky

pageId

string

ID stránky, ve které je skupina

sectionId

string

ID oddílu, ve které je skupina

groupId

string

ID skupiny

removeFromPageId

string

ID stránky, ze které chcete odebrat skupinu

removeFromSectionId

string

ID oddílu pro odebrání skupiny

Návraty

Promise<Group>

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

Přesune skupinu do jiného oddílu.

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

Parametry

group

Group

Aktualizovaná skupina

processId

string

ID procesu

witRefName

string

Název odkazu typu pracovní položky

pageId

string

ID stránky, ve které je skupina

sectionId

string

ID oddílu, ve které je skupina

groupId

string

ID skupiny

removeFromSectionId

string

ID oddílu pro odebrání skupiny

Návraty

Promise<Group>

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Aktualizuje výchozí typ pracovní položky pro chování procesu.

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

Parametry

behavior

WorkItemTypeBehavior

processId

string

ID procesu

witRefNameForBehaviors

string

Název odkazu na typ pracovní položky pro chování

Návraty

Promise<WorkItemTypeBehavior>

updateField(FieldUpdate, string)

Aktualizuje dané pole v procesu.

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

Parametry

field

FieldUpdate

processId

string

ID procesu

Návraty

Promise<FieldModel>

updateList(PickListModel, string)

Aktualizuje seznam.

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

Parametry

picklist

PickListModel

listId

string

ID seznamu

Návraty

Promise<PickListModel>

updateStateDefinition(WorkItemStateInputModel, string, string, string)

Aktualizuje danou definici stavu v typu pracovní položky procesu.

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

Parametry

stateModel

WorkItemStateInputModel

processId

string

ID procesu

witRefName

string

Název odkazu typu pracovní položky

stateId

string

ID stavu

Návraty

Promise<WorkItemStateResultModel>

updateWorkItemType(WorkItemTypeUpdateModel, string, string)

Aktualizuje typ pracovní položky procesu.

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

Parametry

workItemTypeUpdate

WorkItemTypeUpdateModel

processId

string

ID procesu

witRefName

string

Název odkazu typu pracovní položky

Návraty

Promise<WorkItemTypeModel>

updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)

Aktualizuje jedno pole v oboru daného procesu a typu pracovní položky.

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

Parametry

field

WorkItemTypeFieldModel2

Model, pomocí kterého chcete pole aktualizovat

processId

string

ID procesu

witRefNameForFields

string

Referenční název typu pracovní položky pro pole

Návraty

Promise<WorkItemTypeFieldModel2>