WorkItemTrackingProcessDefinitionsRestClient class

Paket:

azure-devops-extension-api

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

Extends

RestClientBase

Konstruktorer

WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)

Egenskaper

RESOURCE_AREA_ID

Metoder

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Lägger till ett beteende i arbetsobjekttypen för processen.
addControlToGroup(Control, string, string, string)	Skapar en kontroll i en grupp
addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)	Lägger till ett fält i arbetsobjekttypen i processen.
addGroup(Group, string, string, string, string)	Lägger till en grupp i arbetsobjektsformuläret
addPage(Page, string, string)	Lägger till en sida i arbetsobjektsformuläret
createBehavior(BehaviorCreateModel, string)	Skapar ett enda beteende i den angivna processen.
createField(FieldModel, string)	Skapar ett enda fält i processen.
createList(PickListModel)	Skapar en listruta.
createStateDefinition(WorkItemStateInputModel, string, string)	Skapar en tillståndsdefinition i arbetsobjekttypen för processen.
createWorkItemType(WorkItemTypeModel, string)	Skapar en typ av arbetsobjekt i processen.
deleteBehavior(string, string)	Tar bort ett beteende i processen.
deleteList(string)	Tar bort en listruta.
deleteStateDefinition(string, string, string)	Tar bort en tillståndsdefinition i arbetsobjekttypen för processen.
deleteWorkItemType(string, string)	Tar bort en typ av arbetsobjekt i processen.
editControl(Control, string, string, string, string)	Uppdateringar en kontroll i arbetsobjektsformuläret
editGroup(Group, string, string, string, string, string)	Uppdateringar en grupp i arbetsobjektsformuläret
editPage(Page, string, string)	Uppdateringar en sida i arbetsobjektsformuläret
getBehavior(string, string)	Returnerar ett enda beteende i processen.
getBehaviorForWorkItemType(string, string, string)	Returnerar ett beteende för arbetsobjekttypen i processen.
getBehaviors(string)	Returnerar en lista över alla beteenden i processen.
getBehaviorsForWorkItemType(string, string)	Returnerar en lista över alla beteenden för arbetsobjekttypen i processen.
getFormLayout(string, string)	Hämtar formulärlayouten
getList(string)	Returnerar en listruta.
getListsMetadata()	Returnerar metadata för listrutan.
getStateDefinition(string, string, string)	Returnerar en tillståndsdefinition i arbetsobjekttypen för processen.
getStateDefinitions(string, string)	Returnerar en lista över alla tillståndsdefinitioner i arbetsobjekttypen i processen.
getWorkItemType(string, string, GetWorkItemTypeExpand)	Returnerar en typ av arbetsobjekt i processen.
getWorkItemTypeField(string, string, string)	Returnerar ett enda fält i arbetsobjekttypen för processen.
getWorkItemTypeFields(string, string)	Returnerar en lista över alla fält i arbetsobjekttypen i processen.
getWorkItemTypes(string, GetWorkItemTypeExpand)	Returnerar en lista över alla typer av arbetsobjekt i processen.
hideStateDefinition(HideStateModel, string, string, string)	Döljer en tillståndsdefinition i arbetsobjekttypen i processen.
removeBehaviorFromWorkItemType(string, string, string)	Tar bort ett beteende för arbetsobjekttypen i processen.
removeControlFromGroup(string, string, string, string)	Tar bort en kontroll från arbetsobjektsformuläret
removeFieldFromWorkItemType(string, string, string)	Tar bort ett fält i arbetsobjekttypen för processen.
removeGroup(string, string, string, string, string)	Tar bort en grupp från arbetsobjektsformuläret
removePage(string, string, string)	Tar bort en sida från arbetsobjektsformuläret
replaceBehavior(BehaviorReplaceModel, string, string)	Ersätter ett beteende i processen.
setControlInGroup(Control, string, string, string, string, string)	Flyttar en kontroll till en ny grupp
setGroupInPage(Group, string, string, string, string, string, string, string)	Flyttar en grupp till en annan sida och ett annat avsnitt
setGroupInSection(Group, string, string, string, string, string, string)	Flyttar en grupp till ett annat avsnitt
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Uppdateringar standardarbetsobjekttyp för processens beteende.
updateField(FieldUpdate, string)	Uppdateringar ett visst fält i processen.
updateList(PickListModel, string)	Uppdateringar en lista.
updateStateDefinition(WorkItemStateInputModel, string, string, string)	Uppdateringar en viss tillståndsdefinition i arbetsobjekttypen för processen.
updateWorkItemType(WorkItemTypeUpdateModel, string, string)	Uppdateringar en arbetsuppgiftstyp i processen.
updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)	Uppdateringar ett enda fält i omfånget för den angivna processen och arbetsobjekttypen.

Konstruktorinformation

WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)

new WorkItemTrackingProcessDefinitionsRestClient(options: IVssRestClientOptions)

Parametrar

options

IVssRestClientOptions

Egenskapsinformation

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Egenskapsvärde

string

Metodinformation

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

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

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

Parametrar

behavior

WorkItemTypeBehavior

processId

string

Processens ID

witRefNameForBehaviors

string

Referensnamn för arbetsobjekttyp för beteendet

Returer

Promise<WorkItemTypeBehavior>

addControlToGroup(Control, string, string, string)

Skapar en kontroll i en grupp

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

Parametrar

control

Control

Kontrollen

processId

string

Processens ID

witRefName

string

Referensnamnet för arbetsobjekttypen

groupId

string

ID för den grupp som kontrollen ska läggas till i

Returer

Promise<Control>

addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)

Lägger till ett fält i arbetsobjekttypen i processen.

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

Parametrar

field

WorkItemTypeFieldModel2

processId

string

Processens ID

witRefNameForFields

string

Referensnamn för arbetsobjekttyp för fältet

Returer

Promise<WorkItemTypeFieldModel2>

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

Lägger till en grupp i arbetsobjektsformuläret

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

Parametrar

group

Group

Gruppen

processId

string

Processens ID

witRefName

string

Referensnamnet för arbetsobjekttypen

pageId

string

Sidans ID för att lägga till gruppen i

sectionId

string

ID för avsnittet för att lägga till gruppen i

Returer

Promise<Group>

addPage(Page, string, string)

Lägger till en sida i arbetsobjektsformuläret

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

Parametrar

page

Page

Sidan

processId

string

Processens ID

witRefName

string

Referensnamnet för arbetsobjekttypen

Returer

Promise<Page>

createBehavior(BehaviorCreateModel, string)

Skapar ett enda beteende i den angivna processen.

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

Parametrar

behavior

BehaviorCreateModel

processId

string

Processens ID

Returer

Promise<BehaviorModel>

createField(FieldModel, string)

Skapar ett enda fält i processen.

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

Parametrar

field

FieldModel

processId

string

Processens ID

Returer

Promise<FieldModel>

createList(PickListModel)

Skapar en listruta.

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

Parametrar

picklist

PickListModel

Returer

Promise<PickListModel>

createStateDefinition(WorkItemStateInputModel, string, string)

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

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

Parametrar

stateModel

WorkItemStateInputModel

processId

string

Processens ID

witRefName

string

Referensnamnet för arbetsobjekttypen

Returer

Promise<WorkItemStateResultModel>

createWorkItemType(WorkItemTypeModel, string)

Skapar en typ av arbetsobjekt i processen.

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

Parametrar

workItemType

WorkItemTypeModel

processId

string

Processens ID

Returer

Promise<WorkItemTypeModel>

deleteBehavior(string, string)

Tar bort ett beteende i processen.

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

Parametrar

processId

string

Processens ID

behaviorId

string

Beteendets ID

Returer

Promise<void>

deleteList(string)

Tar bort en listruta.

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

Parametrar

listId

string

ID:t för listan

Returer

Promise<void>

deleteStateDefinition(string, string, string)

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

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

Parametrar

processId

string

ID för processen

witRefName

string

Referensnamnet för arbetsobjekttypen

stateId

string

ID för tillståndet

Returer

Promise<void>

deleteWorkItemType(string, string)

Tar bort en typ av arbetsobjekt i processen.

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

Parametrar

processId

string

Processens ID

witRefName

string

Referensnamnet för arbetsobjekttypen

Returer

Promise<void>

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

Uppdateringar en kontroll i arbetsobjektsformuläret

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

Parametrar

control

Control

Den uppdaterade kontrollen

processId

string

Processens ID

witRefName

string

Referensnamnet för arbetsobjekttypen

groupId

string

Gruppens ID

controlId

string

ID för kontrollen

Returer

Promise<Control>

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

Uppdateringar en grupp i arbetsobjektsformuläret

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

Parametrar

group

Group

Den uppdaterade gruppen

processId

string

Processens ID

witRefName

string

Referensnamnet för arbetsobjekttypen

pageId

string

ID:t för sidan som gruppen är i

sectionId

string

ID för avsnittet som gruppen är i

groupId

string

Gruppens ID

Returer

Promise<Group>

editPage(Page, string, string)

Uppdateringar en sida i arbetsobjektsformuläret

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

Parametrar

page

Page

Sidan

processId

string

Processens ID

witRefName

string

Referensnamnet för arbetsobjekttypen

Returer

Promise<Page>

getBehavior(string, string)

Returnerar ett enda beteende i processen.

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

Parametrar

processId

string

Processens ID

behaviorId

string

Beteendets ID

Returer

Promise<BehaviorModel>

getBehaviorForWorkItemType(string, string, string)

Returnerar ett beteende för arbetsobjekttypen i processen.

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

Parametrar

processId

string

Processens ID

witRefNameForBehaviors

string

Referensnamn för arbetsobjekttyp för beteendet

behaviorRefName

string

Beteendets referensnamn

Returer

Promise<WorkItemTypeBehavior>

getBehaviors(string)

Returnerar en lista över alla beteenden i processen.

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

Parametrar

processId

string

Processens ID

Returer

Promise<BehaviorModel[]>

getBehaviorsForWorkItemType(string, string)

Returnerar en lista över alla beteenden för arbetsobjekttypen i processen.

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

Parametrar

processId

string

Processens ID

witRefNameForBehaviors

string

Referensnamn för arbetsobjekttyp för beteendet

Returer

Promise<WorkItemTypeBehavior[]>

getFormLayout(string, string)

Hämtar formulärlayouten

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

Parametrar

processId

string

Processens ID

witRefName

string

Referensnamnet för arbetsobjekttypen

Returer

Promise<FormLayout>

getList(string)

Returnerar en listruta.

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

Parametrar

listId

string

ID:t för listan

Returer

Promise<PickListModel>

getListsMetadata()

Returnerar metadata för listrutan.

function getListsMetadata(): Promise<PickListMetadataModel[]>

Returer

Promise<PickListMetadataModel[]>

getStateDefinition(string, string, string)

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

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

Parametrar

processId

string

Processens ID

witRefName

string

Referensnamnet för arbetsobjekttypen

stateId

string

Tillståndets ID

Returer

Promise<WorkItemStateResultModel>

getStateDefinitions(string, string)

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

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

Parametrar

processId

string

Processens ID

witRefName

string

Referensnamnet för arbetsobjekttypen

Returer

Promise<WorkItemStateResultModel[]>

getWorkItemType(string, string, GetWorkItemTypeExpand)

Returnerar en typ av arbetsobjekt i processen.

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

Parametrar

processId

string

Processens ID

witRefName

string

Referensnamnet för arbetsobjekttypen

expand

GetWorkItemTypeExpand

Returer

Promise<WorkItemTypeModel>

getWorkItemTypeField(string, string, string)

Returnerar ett enda fält i arbetsobjekttypen för processen.

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

Parametrar

processId

string

Processens ID

witRefNameForFields

string

Referensnamn för arbetsobjekttyp för fält

fieldRefName

string

Fältets referensnamn

Returer

Promise<WorkItemTypeFieldModel2>

getWorkItemTypeFields(string, string)

Returnerar en lista över alla fält i arbetsobjekttypen i processen.

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

Parametrar

processId

string

Processens ID

witRefNameForFields

string

Referensnamn för arbetsobjekttyp för fält

Returer

Promise<WorkItemTypeFieldModel2[]>

getWorkItemTypes(string, GetWorkItemTypeExpand)

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

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

Parametrar

processId

string

Processens ID

expand

GetWorkItemTypeExpand

Returer

Promise<WorkItemTypeModel[]>

hideStateDefinition(HideStateModel, string, string, string)

Döljer en tillståndsdefinition i arbetsobjekttypen i processen.

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

Parametrar

hideStateModel

HideStateModel

processId

string

Processens ID

witRefName

string

Referensnamnet för arbetsobjekttypen

stateId

string

Tillståndets ID

Returer

Promise<WorkItemStateResultModel>

removeBehaviorFromWorkItemType(string, string, string)

Tar bort ett beteende för arbetsobjekttypen i processen.

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

Parametrar

processId

string

Processens ID

witRefNameForBehaviors

string

Referensnamn för arbetsobjekttyp för beteendet

behaviorRefName

string

Beteendets referensnamn

Returer

Promise<void>

removeControlFromGroup(string, string, string, string)

Tar bort en kontroll från arbetsobjektsformuläret

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

Parametrar

processId

string

Processens ID

witRefName

string

Referensnamnet för arbetsobjekttypen

groupId

string

Gruppens ID

controlId

string

ID för kontrollen som ska tas bort

Returer

Promise<void>

removeFieldFromWorkItemType(string, string, string)

Tar bort ett fält i arbetsobjekttypen för processen.

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

Parametrar

processId

string

Processens ID

witRefNameForFields

string

Referensnamn för arbetsobjekttyp för fält

fieldRefName

string

Fältets referensnamn

Returer

Promise<void>

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

Tar bort en grupp från arbetsobjektsformuläret

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

Parametrar

processId

string

Processens ID

witRefName

string

Referensnamnet för arbetsobjekttypen

pageId

string

ID:t för sidan som gruppen är i

sectionId

string

ID:t för avsnittet till gruppen finns i

groupId

string

Gruppens ID

Returer

Promise<void>

removePage(string, string, string)

Tar bort en sida från arbetsobjektsformuläret

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

Parametrar

processId

string

Processens ID

witRefName

string

Referensnamnet för arbetsobjekttypen

pageId

string

Sidans ID

Returer

Promise<void>

replaceBehavior(BehaviorReplaceModel, string, string)

Ersätter ett beteende i processen.

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

Parametrar

behaviorData

BehaviorReplaceModel

processId

string

Processens ID

behaviorId

string

Beteendets ID

Returer

Promise<BehaviorModel>

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

Flyttar en kontroll till en ny grupp

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

Parametrar

control

Control

Kontrollen

processId

string

Processens ID

witRefName

string

Referensnamnet för arbetsobjekttypen

groupId

string

ID för den grupp som kontrollen ska flyttas till

controlId

string

Kontrollens ID

removeFromGroupId

string

Gruppen som kontrollen ska tas bort från

Returer

Promise<Control>

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

Flyttar en grupp till en annan sida och ett annat avsnitt

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

Parametrar

group

Group

Den uppdaterade gruppen

processId

string

Processens ID

witRefName

string

Referensnamnet för arbetsobjekttypen

pageId

string

ID:t för sidan som gruppen är i

sectionId

string

ID för avsnittet som gruppen är i

groupId

string

Gruppens ID

removeFromPageId

string

ID för sidan för att ta bort gruppen från

removeFromSectionId

string

ID för avsnittet för att ta bort gruppen från

Returer

Promise<Group>

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

Flyttar en grupp till ett annat avsnitt

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

Parametrar

group

Group

Den uppdaterade gruppen

processId

string

Processens ID

witRefName

string

Referensnamnet för arbetsobjekttypen

pageId

string

ID:t för sidan som gruppen är i

sectionId

string

ID för avsnittet som gruppen är i

groupId

string

Gruppens ID

removeFromSectionId

string

ID för avsnittet för att ta bort gruppen från

Returer

Promise<Group>

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Uppdateringar standardarbetsobjekttyp för processens beteende.

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

Parametrar

behavior

WorkItemTypeBehavior

processId

string

Processens ID

witRefNameForBehaviors

string

Referensnamn för arbetsobjekttyp för beteendet

Returer

Promise<WorkItemTypeBehavior>

updateField(FieldUpdate, string)

Uppdateringar ett visst fält i processen.

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

Parametrar

field

FieldUpdate

processId

string

Processens ID

Returer

Promise<FieldModel>

updateList(PickListModel, string)

Uppdateringar en lista.

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

Parametrar

picklist

PickListModel

listId

string

ID:t för listan

Returer

Promise<PickListModel>

updateStateDefinition(WorkItemStateInputModel, string, string, string)

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

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

Parametrar

stateModel

WorkItemStateInputModel

processId

string

ID för processen

witRefName

string

Referensnamnet för arbetsobjekttypen

stateId

string

ID för tillståndet

Returer

Promise<WorkItemStateResultModel>

updateWorkItemType(WorkItemTypeUpdateModel, string, string)

Uppdateringar en arbetsuppgiftstyp i processen.

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

Parametrar

workItemTypeUpdate

WorkItemTypeUpdateModel

processId

string

Processens ID

witRefName

string

Referensnamnet för arbetsobjekttypen

Returer

Promise<WorkItemTypeModel>

updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)

Uppdateringar ett enda fält i omfånget för den angivna processen och arbetsobjekttypen.

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

Parametrar

field

WorkItemTypeFieldModel2

Den modell som fältet ska uppdateras med

processId

string

Processens ID

witRefNameForFields

string

Referensnamn för arbetsobjekttyp för fält

Returer

Promise<WorkItemTypeFieldModel2>