WorkItemTrackingProcessDefinitionsRestClient class

Paket:

azure-devops-extension-api

VSS REST api'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf

Extends

RestClientBase

Oluşturucular

WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)

Özellikler

RESOURCE_AREA_ID

Yöntemler

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	İşlemin iş öğesi türüne bir davranış ekler.
addControlToGroup(Control, string, string, string)	Grupta bir denetim oluşturur
addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)	İşlemdeki iş öğesi türüne bir alan ekler.
addGroup(Group, string, string, string, string)	İş öğesi formuna bir grup ekler
addPage(Page, string, string)	İş öğesi formuna bir sayfa ekler
createBehavior(BehaviorCreateModel, string)	Verilen süreçte tek bir davranış oluşturur.
createField(FieldModel, string)	İşlemde tek bir alan oluşturur.
createList(PickListModel)	Bir seçim listesi oluşturur.
createStateDefinition(WorkItemStateInputModel, string, string)	İşlemin iş öğesi türünde bir durum tanımı oluşturur.
createWorkItemType(WorkItemTypeModel, string)	İşlemde bir iş öğesi türü oluşturur.
deleteBehavior(string, string)	İşlemdeki bir davranışı kaldırır.
deleteList(string)	Seçim listesini kaldırır.
deleteStateDefinition(string, string, string)	İşlemin iş öğesi türündeki bir durum tanımını kaldırır.
deleteWorkItemType(string, string)	İşlemdeki bir iş öğesi türünü kaldırır.
editControl(Control, string, string, string, string)	İş öğesi formundaki bir denetimi güncelleştirir
editGroup(Group, string, string, string, string, string)	İş öğesi formundaki bir grubu güncelleştirir
editPage(Page, string, string)	İş öğesi formundaki bir sayfayı güncelleştirir
getBehavior(string, string)	İşlemdeki tek bir davranışı döndürür.
getBehaviorForWorkItemType(string, string, string)	İşlemin iş öğesi türü için bir davranış döndürür.
getBehaviors(string)	İşlemdeki tüm davranışların listesini döndürür.
getBehaviorsForWorkItemType(string, string)	İşlemin iş öğesi türü için tüm davranışların bir listesini döndürür.
getFormLayout(string, string)	Form düzenini alır
getList(string)	Bir seçim listesi döndürür.
getListsMetadata()	Seçim listesinin meta verilerini döndürür.
getStateDefinition(string, string, string)	İşlemin iş öğesi türünde bir durum tanımı döndürür.
getStateDefinitions(string, string)	İşlemin iş öğesi türündeki tüm durum tanımlarının bir listesini döndürür.
getWorkItemType(string, string, GetWorkItemTypeExpand)	İşlemin iş öğesi türünü döndürür.
getWorkItemTypeField(string, string, string)	İşlemin iş öğesi türünde tek bir alan döndürür.
getWorkItemTypeFields(string, string)	İşlemin iş öğesi türündeki tüm alanların bir listesini döndürür.
getWorkItemTypes(string, GetWorkItemTypeExpand)	İşlemdeki tüm iş öğesi türlerinin bir listesini döndürür.
hideStateDefinition(HideStateModel, string, string, string)	İşlemin iş öğesi türünde bir durum tanımını gizler.
removeBehaviorFromWorkItemType(string, string, string)	İşlemin iş öğesi türü için bir davranışı kaldırır.
removeControlFromGroup(string, string, string, string)	İş öğesi formundan bir denetimi kaldırır
removeFieldFromWorkItemType(string, string, string)	İşlemin iş öğesi türündeki bir alanı kaldırır.
removeGroup(string, string, string, string, string)	İş öğesi formundan bir grubu kaldırır
removePage(string, string, string)	İş öğesi formundan bir sayfayı kaldırır
replaceBehavior(BehaviorReplaceModel, string, string)	Süreçteki bir davranışın yerini alır.
setControlInGroup(Control, string, string, string, string, string)	Denetimi yeni bir gruba taşır
setGroupInPage(Group, string, string, string, string, string, string, string)	Grubu farklı bir sayfaya ve bölüme taşır
setGroupInSection(Group, string, string, string, string, string, string)	Grubu farklı bir bölüme taşır
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	İşlemin davranışı için varsayılan iş öğesi türünü güncelleştirir.
updateField(FieldUpdate, string)	İşlemdeki belirli bir alanı günceller.
updateList(PickListModel, string)	Listeyi güncelleştirir.
updateStateDefinition(WorkItemStateInputModel, string, string, string)	İşlemin iş öğesi türünde belirli bir durum tanımını güncelleştirir.
updateWorkItemType(WorkItemTypeUpdateModel, string, string)	İşlemin iş öğesi türünü güncelleştirir.
updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)	Verilen işlem ve iş öğesi türü kapsamındaki tek bir alanı güncelleştirir.

Oluşturucu Ayrıntıları

WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)

new WorkItemTrackingProcessDefinitionsRestClient(options: IVssRestClientOptions)

Parametreler

options

IVssRestClientOptions

Özellik Ayrıntıları

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Özellik Değeri

string

Yöntem Ayrıntıları

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

İşlemin iş öğesi türüne bir davranış ekler.

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

Parametreler

behavior

WorkItemTypeBehavior

processId

string

İşlemin kimliği

witRefNameForBehaviors

string

Davranış için iş öğesi türü başvuru adı

Döndürülenler

Promise<WorkItemTypeBehavior>

addControlToGroup(Control, string, string, string)

Grupta bir denetim oluşturur

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

Parametreler

control

Control

Kontrol

processId

string

İşlemin kimliği

witRefName

string

İş öğesi türünün başvuru adı

groupId

string

Denetimin ekleneceği grubun kimliği

Döndürülenler

Promise<Control>

addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)

İşlemdeki iş öğesi türüne bir alan ekler.

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

Parametreler

field

WorkItemTypeFieldModel2

processId

string

İşlemin kimliği

witRefNameForFields

string

Alan için iş öğesi türü başvuru adı

Döndürülenler

Promise<WorkItemTypeFieldModel2>

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

İş öğesi formuna bir grup ekler

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

Parametreler

group

Group

Grup

processId

string

İşlemin kimliği

witRefName

string

İş öğesi türünün başvuru adı

pageId

string

Grubun ekleneceği sayfanın kimliği

sectionId

string

Grubun ekleneceği bölümün kimliği

Döndürülenler

Promise<Group>

addPage(Page, string, string)

İş öğesi formuna bir sayfa ekler

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

Parametreler

page

Page

Sayfa

processId

string

İşlemin kimliği

witRefName

string

İş öğesi türünün başvuru adı

Döndürülenler

Promise<Page>

createBehavior(BehaviorCreateModel, string)

Verilen süreçte tek bir davranış oluşturur.

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

Parametreler

behavior

BehaviorCreateModel

processId

string

İşlemin kimliği

Döndürülenler

Promise<BehaviorModel>

createField(FieldModel, string)

İşlemde tek bir alan oluşturur.

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

Parametreler

field

FieldModel

processId

string

İşlemin kimliği

Döndürülenler

Promise<FieldModel>

createList(PickListModel)

Bir seçim listesi oluşturur.

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

Parametreler

picklist

PickListModel

Döndürülenler

Promise<PickListModel>

createStateDefinition(WorkItemStateInputModel, string, string)

İşlemin iş öğesi türünde bir durum tanımı oluşturur.

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

Parametreler

stateModel

WorkItemStateInputModel

processId

string

İşlemin kimliği

witRefName

string

İş öğesi türünün başvuru adı

Döndürülenler

Promise<WorkItemStateResultModel>

createWorkItemType(WorkItemTypeModel, string)

İşlemde bir iş öğesi türü oluşturur.

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

Parametreler

workItemType

WorkItemTypeModel

processId

string

İşlemin kimliği

Döndürülenler

Promise<WorkItemTypeModel>

deleteBehavior(string, string)

İşlemdeki bir davranışı kaldırır.

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

Parametreler

processId

string

İşlemin kimliği

behaviorId

string

Davranışın kimliği

Döndürülenler

Promise<void>

deleteList(string)

Seçim listesini kaldırır.

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

Parametreler

listId

string

Listenin kimliği

Döndürülenler

Promise<void>

deleteStateDefinition(string, string, string)

İşlemin iş öğesi türündeki bir durum tanımını kaldırır.

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

Parametreler

processId

string

İşlemin kimliği

witRefName

string

İş öğesi türünün başvuru adı

stateId

string

Eyaletin kimliği

Döndürülenler

Promise<void>

deleteWorkItemType(string, string)

İşlemdeki bir iş öğesi türünü kaldırır.

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

Parametreler

processId

string

İşlemin kimliği

witRefName

string

İş öğesi türünün başvuru adı

Döndürülenler

Promise<void>

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

İş öğesi formundaki bir denetimi güncelleştirir

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

Parametreler

control

Control

Güncelleştirilmiş kontrol

processId

string

İşlemin kimliği

witRefName

string

İş öğesi türünün başvuru adı

groupId

string

Grubun kimliği

controlId

string

Denetimin kimliği

Döndürülenler

Promise<Control>

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

İş öğesi formundaki bir grubu güncelleştirir

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

Parametreler

group

Group

Güncelleştirilmiş grup

processId

string

İşlemin kimliği

witRefName

string

İş öğesi türünün başvuru adı

pageId

string

Grubun bulunduğu sayfanın kimliği

sectionId

string

Grubun bulunduğu bölümün kimliği

groupId

string

Grubun kimliği

Döndürülenler

Promise<Group>

editPage(Page, string, string)

İş öğesi formundaki bir sayfayı güncelleştirir

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

Parametreler

page

Page

Sayfa

processId

string

İşlemin kimliği

witRefName

string

İş öğesi türünün başvuru adı

Döndürülenler

Promise<Page>

getBehavior(string, string)

İşlemdeki tek bir davranışı döndürür.

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

Parametreler

processId

string

İşlemin kimliği

behaviorId

string

Davranışın kimliği

Döndürülenler

Promise<BehaviorModel>

getBehaviorForWorkItemType(string, string, string)

İşlemin iş öğesi türü için bir davranış döndürür.

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

Parametreler

processId

string

İşlemin kimliği

witRefNameForBehaviors

string

Davranış için iş öğesi türü başvuru adı

behaviorRefName

string

Davranışın başvuru adı

Döndürülenler

Promise<WorkItemTypeBehavior>

getBehaviors(string)

İşlemdeki tüm davranışların listesini döndürür.

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

Parametreler

processId

string

İşlemin kimliği

Döndürülenler

Promise<BehaviorModel[]>

getBehaviorsForWorkItemType(string, string)

İşlemin iş öğesi türü için tüm davranışların bir listesini döndürür.

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

Parametreler

processId

string

İşlemin kimliği

witRefNameForBehaviors

string

Davranış için iş öğesi türü başvuru adı

Döndürülenler

Promise<WorkItemTypeBehavior[]>

getFormLayout(string, string)

Form düzenini alır

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

Parametreler

processId

string

İşlemin kimliği

witRefName

string

İş öğesi türünün başvuru adı

Döndürülenler

Promise<FormLayout>

getList(string)

Bir seçim listesi döndürür.

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

Parametreler

listId

string

Listenin kimliği

Döndürülenler

Promise<PickListModel>

getListsMetadata()

Seçim listesinin meta verilerini döndürür.

function getListsMetadata(): Promise<PickListMetadataModel[]>

Döndürülenler

Promise<PickListMetadataModel[]>

getStateDefinition(string, string, string)

İşlemin iş öğesi türünde bir durum tanımı döndürür.

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

Parametreler

processId

string

İşlemin kimliği

witRefName

string

İş öğesi türünün başvuru adı

stateId

string

Eyaletin kimliği

Döndürülenler

Promise<WorkItemStateResultModel>

getStateDefinitions(string, string)

İşlemin iş öğesi türündeki tüm durum tanımlarının bir listesini döndürür.

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

Parametreler

processId

string

İşlemin kimliği

witRefName

string

İş öğesi türünün başvuru adı

Döndürülenler

Promise<WorkItemStateResultModel[]>

getWorkItemType(string, string, GetWorkItemTypeExpand)

İşlemin iş öğesi türünü döndürür.

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

Parametreler

processId

string

İşlemin kimliği

witRefName

string

İş öğesi türünün başvuru adı

expand

GetWorkItemTypeExpand

Döndürülenler

Promise<WorkItemTypeModel>

getWorkItemTypeField(string, string, string)

İşlemin iş öğesi türünde tek bir alan döndürür.

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

Parametreler

processId

string

İşlemin kimliği

witRefNameForFields

string

Alanlar için iş öğesi türü başvuru adı

fieldRefName

string

Alanın başvuru adı

Döndürülenler

Promise<WorkItemTypeFieldModel2>

getWorkItemTypeFields(string, string)

İşlemin iş öğesi türündeki tüm alanların bir listesini döndürür.

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

Parametreler

processId

string

İşlemin kimliği

witRefNameForFields

string

Alanlar için iş öğesi türü başvuru adı

Döndürülenler

Promise<WorkItemTypeFieldModel2[]>

getWorkItemTypes(string, GetWorkItemTypeExpand)

İşlemdeki tüm iş öğesi türlerinin bir listesini döndürür.

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

Parametreler

processId

string

İşlemin kimliği

expand

GetWorkItemTypeExpand

Döndürülenler

Promise<WorkItemTypeModel[]>

hideStateDefinition(HideStateModel, string, string, string)

İşlemin iş öğesi türünde bir durum tanımını gizler.

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

Parametreler

hideStateModel

HideStateModel

processId

string

İşlemin kimliği

witRefName

string

İş öğesi türünün başvuru adı

stateId

string

Eyaletin kimliği

Döndürülenler

Promise<WorkItemStateResultModel>

removeBehaviorFromWorkItemType(string, string, string)

İşlemin iş öğesi türü için bir davranışı kaldırır.

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

Parametreler

processId

string

İşlemin kimliği

witRefNameForBehaviors

string

Davranış için iş öğesi türü başvuru adı

behaviorRefName

string

Davranışın başvuru adı

Döndürülenler

Promise<void>

removeControlFromGroup(string, string, string, string)

İş öğesi formundan bir denetimi kaldırır

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

Parametreler

processId

string

İşlemin kimliği

witRefName

string

İş öğesi türünün başvuru adı

groupId

string

Grubun kimliği

controlId

string

Kaldırılacak denetimin kimliği

Döndürülenler

Promise<void>

removeFieldFromWorkItemType(string, string, string)

İşlemin iş öğesi türündeki bir alanı kaldırır.

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

Parametreler

processId

string

İşlemin kimliği

witRefNameForFields

string

Alanlar için iş öğesi türü başvuru adı

fieldRefName

string

Alanın başvuru adı

Döndürülenler

Promise<void>

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

İş öğesi formundan bir grubu kaldırır

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

Parametreler

processId

string

İşlemin kimliği

witRefName

string

İş öğesi türünün başvuru adı

pageId

string

Grubun bulunduğu sayfanın kimliği

sectionId

string

Grubun bulunduğu bölümün kimliği

groupId

string

Grubun kimliği

Döndürülenler

Promise<void>

removePage(string, string, string)

İş öğesi formundan bir sayfayı kaldırır

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

Parametreler

processId

string

İşlemin kimliği

witRefName

string

İş öğesi türünün başvuru adı

pageId

string

Sayfanın kimliği

Döndürülenler

Promise<void>

replaceBehavior(BehaviorReplaceModel, string, string)

Süreçteki bir davranışın yerini alır.

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

Parametreler

behaviorData

BehaviorReplaceModel

processId

string

İşlemin kimliği

behaviorId

string

Davranışın kimliği

Döndürülenler

Promise<BehaviorModel>

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

Denetimi yeni bir gruba taşır

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

Parametreler

control

Control

Kontrol

processId

string

İşlemin kimliği

witRefName

string

İş öğesi türünün başvuru adı

groupId

string

Denetimin taşınacağı grubun kimliği

controlId

string

Denetimin kimliği

removeFromGroupId

string

Denetimin kaldırılacağı grup

Döndürülenler

Promise<Control>

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

Grubu farklı bir sayfaya ve bölüme taşır

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

Parametreler

group

Group

Güncelleştirilmiş grup

processId

string

İşlemin kimliği

witRefName

string

İş öğesi türünün başvuru adı

pageId

string

Grubun bulunduğu sayfanın kimliği

sectionId

string

Grubun bulunduğu bölümün kimliği

groupId

string

Grubun kimliği

removeFromPageId

string

Grubun kaldırılacağı sayfanın kimliği

removeFromSectionId

string

Grubun kaldırılacağı bölümün kimliği

Döndürülenler

Promise<Group>

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

Grubu farklı bir bölüme taşır

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

Parametreler

group

Group

Güncelleştirilmiş grup

processId

string

İşlemin kimliği

witRefName

string

İş öğesi türünün başvuru adı

pageId

string

Grubun bulunduğu sayfanın kimliği

sectionId

string

Grubun bulunduğu bölümün kimliği

groupId

string

Grubun kimliği

removeFromSectionId

string

Grubun kaldırılacağı bölümün kimliği

Döndürülenler

Promise<Group>

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

İşlemin davranışı için varsayılan iş öğesi türünü güncelleştirir.

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

Parametreler

behavior

WorkItemTypeBehavior

processId

string

İşlemin kimliği

witRefNameForBehaviors

string

Davranış için iş öğesi türü başvuru adı

Döndürülenler

Promise<WorkItemTypeBehavior>

updateField(FieldUpdate, string)

İşlemdeki belirli bir alanı günceller.

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

Parametreler

field

FieldUpdate

processId

string

İşlemin kimliği

Döndürülenler

Promise<FieldModel>

updateList(PickListModel, string)

Listeyi güncelleştirir.

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

Parametreler

picklist

PickListModel

listId

string

Listenin kimliği

Döndürülenler

Promise<PickListModel>

updateStateDefinition(WorkItemStateInputModel, string, string, string)

İşlemin iş öğesi türünde belirli bir durum tanımını güncelleştirir.

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

Parametreler

stateModel

WorkItemStateInputModel

processId

string

İşlemin kimliği

witRefName

string

İş öğesi türünün başvuru adı

stateId

string

Eyaletin kimliği

Döndürülenler

Promise<WorkItemStateResultModel>

updateWorkItemType(WorkItemTypeUpdateModel, string, string)

İşlemin iş öğesi türünü güncelleştirir.

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

Parametreler

workItemTypeUpdate

WorkItemTypeUpdateModel

processId

string

İşlemin kimliği

witRefName

string

İş öğesi türünün başvuru adı

Döndürülenler

Promise<WorkItemTypeModel>

updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)

Verilen işlem ve iş öğesi türü kapsamındaki tek bir alanı güncelleştirir.

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

Parametreler

field

WorkItemTypeFieldModel2

Alanın güncelleştirileceği model

processId

string

İşlemin kimliği

witRefNameForFields

string

Alanlar için iş öğesi türü başvuru adı

Döndürülenler

Promise<WorkItemTypeFieldModel2>