WorkItemTrackingProcessDefinitionsRestClient class

Paket:

azure-devops-extension-api

Kelas dasar yang harus digunakan (berasal dari) untuk membuat permintaan ke VSS REST api

Memperluas

RestClientBase

Konstruktor

WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)

Properti

RESOURCE_AREA_ID

Metode

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Menambahkan perilaku ke jenis item kerja proses.
addControlToGroup(Control, string, string, string)	Membuat kontrol dalam grup
addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)	Menambahkan bidang ke jenis item kerja dalam proses.
addGroup(Group, string, string, string, string)	Menambahkan grup ke formulir item kerja
addPage(Page, string, string)	Menambahkan halaman ke formulir item kerja
createBehavior(BehaviorCreateModel, string)	Menciptakan perilaku tunggal dalam proses yang diberikan.
createField(FieldModel, string)	Membuat satu bidang dalam proses.
createList(PickListModel)	Membuat daftar pilihan.
createStateDefinition(WorkItemStateInputModel, string, string)	Membuat definisi status dalam jenis item kerja proses.
createWorkItemType(WorkItemTypeModel, string)	Membuat jenis item kerja dalam proses.
deleteBehavior(string, string)	Menghapus perilaku dalam proses.
deleteList(string)	Menghapus daftar pilihan.
deleteStateDefinition(string, string, string)	Menghapus definisi status dalam jenis item kerja proses.
deleteWorkItemType(string, string)	Menghapus jenis item kerja dalam proses.
editControl(Control, string, string, string, string)	Memperbarui kontrol pada formulir item kerja
editGroup(Group, string, string, string, string, string)	Memperbarui grup dalam formulir item kerja
editPage(Page, string, string)	Memperbarui halaman pada formulir item kerja
getBehavior(string, string)	Mengembalikan satu perilaku dalam proses.
getBehaviorForWorkItemType(string, string, string)	Mengembalikan perilaku untuk jenis item kerja proses.
getBehaviors(string)	Mengembalikan daftar semua perilaku dalam proses.
getBehaviorsForWorkItemType(string, string)	Mengembalikan daftar semua perilaku untuk jenis item kerja proses.
getFormLayout(string, string)	Mendapatkan tata letak formulir
getList(string)	Mengembalikan daftar pilihan.
getListsMetadata()	Mengembalikan data meta dari daftar pilihan.
getStateDefinition(string, string, string)	Mengembalikan definisi status dalam jenis item kerja proses.
getStateDefinitions(string, string)	Mengembalikan daftar semua definisi status dalam jenis item kerja proses.
getWorkItemType(string, string, GetWorkItemTypeExpand)	Mengembalikan jenis item kerja proses.
getWorkItemTypeField(string, string, string)	Mengembalikan satu bidang dalam jenis item kerja proses.
getWorkItemTypeFields(string, string)	Mengembalikan daftar semua bidang dalam jenis item kerja proses.
getWorkItemTypes(string, GetWorkItemTypeExpand)	Mengembalikan daftar semua jenis item kerja dalam proses.
hideStateDefinition(HideStateModel, string, string, string)	Menyembunyikan definisi status dalam jenis item kerja proses.
removeBehaviorFromWorkItemType(string, string, string)	Menghapus perilaku untuk jenis item kerja proses.
removeControlFromGroup(string, string, string, string)	Menghapus kontrol dari formulir item kerja
removeFieldFromWorkItemType(string, string, string)	Menghapus bidang dalam jenis item kerja proses.
removeGroup(string, string, string, string, string)	Menghapus grup dari formulir item kerja
removePage(string, string, string)	Menghapus halaman dari formulir item kerja
replaceBehavior(BehaviorReplaceModel, string, string)	Menggantikan perilaku dalam prosesnya.
setControlInGroup(Control, string, string, string, string, string)	Memindahkan kontrol ke grup baru
setGroupInPage(Group, string, string, string, string, string, string, string)	Memindahkan grup ke halaman dan bagian yang berbeda
setGroupInSection(Group, string, string, string, string, string, string)	Memindahkan grup ke bagian lain
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)	Memperbarui jenis item kerja default untuk perilaku proses.
updateField(FieldUpdate, string)	Memperbarui bidang tertentu dalam proses.
updateList(PickListModel, string)	Memperbarui daftar.
updateStateDefinition(WorkItemStateInputModel, string, string, string)	Memperbarui definisi status tertentu dalam jenis item kerja proses.
updateWorkItemType(WorkItemTypeUpdateModel, string, string)	Memperbarui jenis item kerja proses.
updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)	Memperbarui satu bidang dalam cakupan proses dan jenis item kerja yang diberikan.

Detail Konstruktor

WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)

new WorkItemTrackingProcessDefinitionsRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Detail Properti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Nilai Properti

string

Detail Metode

addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Menambahkan perilaku ke jenis item kerja proses.

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

Parameter

behavior

WorkItemTypeBehavior

processId

string

ID proses

witRefNameForBehaviors

string

Nama referensi jenis item kerja untuk perilaku

Mengembalikan

Promise<WorkItemTypeBehavior>

addControlToGroup(Control, string, string, string)

Membuat kontrol dalam grup

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

Parameter

control

Control

Kontrol

processId

string

ID proses

witRefName

string

Nama referensi jenis item kerja

groupId

string

ID grup untuk menambahkan kontrol

Mengembalikan

Promise<Control>

addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)

Menambahkan bidang ke jenis item kerja dalam proses.

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

Parameter

field

WorkItemTypeFieldModel2

processId

string

ID proses

witRefNameForFields

string

Nama referensi jenis item kerja untuk bidang

Mengembalikan

Promise<WorkItemTypeFieldModel2>

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

Menambahkan grup ke formulir item kerja

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

Parameter

group

Group

Kelompok

processId

string

ID proses

witRefName

string

Nama referensi jenis item kerja

pageId

string

ID halaman untuk menambahkan grup

sectionId

string

ID bagian untuk menambahkan grup

Mengembalikan

Promise<Group>

addPage(Page, string, string)

Menambahkan halaman ke formulir item kerja

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

Parameter

page

Page

Halaman

processId

string

ID proses

witRefName

string

Nama referensi jenis item kerja

Mengembalikan

Promise<Page>

createBehavior(BehaviorCreateModel, string)

Menciptakan perilaku tunggal dalam proses yang diberikan.

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

Parameter

behavior

BehaviorCreateModel

processId

string

ID proses

Mengembalikan

Promise<BehaviorModel>

createField(FieldModel, string)

Membuat satu bidang dalam proses.

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

Parameter

field

FieldModel

processId

string

ID proses

Mengembalikan

Promise<FieldModel>

createList(PickListModel)

Membuat daftar pilihan.

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

Parameter

picklist

PickListModel

Mengembalikan

Promise<PickListModel>

createStateDefinition(WorkItemStateInputModel, string, string)

Membuat definisi status dalam jenis item kerja proses.

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

Parameter

stateModel

WorkItemStateInputModel

processId

string

ID proses

witRefName

string

Nama referensi jenis item kerja

Mengembalikan

Promise<WorkItemStateResultModel>

createWorkItemType(WorkItemTypeModel, string)

Membuat jenis item kerja dalam proses.

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

Parameter

workItemType

WorkItemTypeModel

processId

string

ID proses

Mengembalikan

Promise<WorkItemTypeModel>

deleteBehavior(string, string)

Menghapus perilaku dalam proses.

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

Parameter

processId

string

ID proses

behaviorId

string

ID perilaku

Mengembalikan

Promise<void>

deleteList(string)

Menghapus daftar pilihan.

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

Parameter

listId

string

ID daftar

Mengembalikan

Promise<void>

deleteStateDefinition(string, string, string)

Menghapus definisi status dalam jenis item kerja proses.

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

Parameter

processId

string

ID proses

witRefName

string

Nama referensi jenis item kerja

stateId

string

ID negara bagian

Mengembalikan

Promise<void>

deleteWorkItemType(string, string)

Menghapus jenis item kerja dalam proses.

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

Parameter

processId

string

ID proses

witRefName

string

Nama referensi jenis item kerja

Mengembalikan

Promise<void>

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

Memperbarui kontrol pada formulir item kerja

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

Parameter

control

Control

Kontrol yang diperbarui

processId

string

ID proses

witRefName

string

Nama referensi jenis item kerja

groupId

string

ID grup

controlId

string

ID kontrol

Mengembalikan

Promise<Control>

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

Memperbarui grup dalam formulir item kerja

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

Parameter

group

Group

Grup yang diperbarui

processId

string

ID proses

witRefName

string

Nama referensi jenis item kerja

pageId

string

ID halaman tempat grup berada

sectionId

string

ID bagian tempat grup berada

groupId

string

ID grup

Mengembalikan

Promise<Group>

editPage(Page, string, string)

Memperbarui halaman pada formulir item kerja

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

Parameter

page

Page

Halaman

processId

string

ID proses

witRefName

string

Nama referensi jenis item kerja

Mengembalikan

Promise<Page>

getBehavior(string, string)

Mengembalikan satu perilaku dalam proses.

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

Parameter

processId

string

ID proses

behaviorId

string

ID perilaku

Mengembalikan

Promise<BehaviorModel>

getBehaviorForWorkItemType(string, string, string)

Mengembalikan perilaku untuk jenis item kerja proses.

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

Parameter

processId

string

ID proses

witRefNameForBehaviors

string

Nama referensi jenis item kerja untuk perilaku

behaviorRefName

string

Nama referensi perilaku

Mengembalikan

Promise<WorkItemTypeBehavior>

getBehaviors(string)

Mengembalikan daftar semua perilaku dalam proses.

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

Parameter

processId

string

ID proses

Mengembalikan

Promise<BehaviorModel[]>

getBehaviorsForWorkItemType(string, string)

Mengembalikan daftar semua perilaku untuk jenis item kerja proses.

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

Parameter

processId

string

ID proses

witRefNameForBehaviors

string

Nama referensi jenis item kerja untuk perilaku

Mengembalikan

Promise<WorkItemTypeBehavior[]>

getFormLayout(string, string)

Mendapatkan tata letak formulir

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

Parameter

processId

string

ID proses

witRefName

string

Nama referensi jenis item kerja

Mengembalikan

Promise<FormLayout>

getList(string)

Mengembalikan daftar pilihan.

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

Parameter

listId

string

ID daftar

Mengembalikan

Promise<PickListModel>

getListsMetadata()

Mengembalikan data meta dari daftar pilihan.

function getListsMetadata(): Promise<PickListMetadataModel[]>

Mengembalikan

Promise<PickListMetadataModel[]>

getStateDefinition(string, string, string)

Mengembalikan definisi status dalam jenis item kerja proses.

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

Parameter

processId

string

ID proses

witRefName

string

Nama referensi jenis item kerja

stateId

string

ID negara bagian

Mengembalikan

Promise<WorkItemStateResultModel>

getStateDefinitions(string, string)

Mengembalikan daftar semua definisi status dalam jenis item kerja proses.

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

Parameter

processId

string

ID proses

witRefName

string

Nama referensi jenis item kerja

Mengembalikan

Promise<WorkItemStateResultModel[]>

getWorkItemType(string, string, GetWorkItemTypeExpand)

Mengembalikan jenis item kerja proses.

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

Parameter

processId

string

ID proses

witRefName

string

Nama referensi jenis item kerja

expand

GetWorkItemTypeExpand

Mengembalikan

Promise<WorkItemTypeModel>

getWorkItemTypeField(string, string, string)

Mengembalikan satu bidang dalam jenis item kerja proses.

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

Parameter

processId

string

ID proses

witRefNameForFields

string

Nama referensi jenis item kerja untuk bidang

fieldRefName

string

Nama referensi bidang

Mengembalikan

Promise<WorkItemTypeFieldModel2>

getWorkItemTypeFields(string, string)

Mengembalikan daftar semua bidang dalam jenis item kerja proses.

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

Parameter

processId

string

ID proses

witRefNameForFields

string

Nama referensi jenis item kerja untuk bidang

Mengembalikan

Promise<WorkItemTypeFieldModel2[]>

getWorkItemTypes(string, GetWorkItemTypeExpand)

Mengembalikan daftar semua jenis item kerja dalam proses.

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

Parameter

processId

string

ID proses

expand

GetWorkItemTypeExpand

Mengembalikan

Promise<WorkItemTypeModel[]>

hideStateDefinition(HideStateModel, string, string, string)

Menyembunyikan definisi status dalam jenis item kerja proses.

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

Parameter

hideStateModel

HideStateModel

processId

string

ID proses

witRefName

string

Nama referensi jenis item kerja

stateId

string

ID negara bagian

Mengembalikan

Promise<WorkItemStateResultModel>

removeBehaviorFromWorkItemType(string, string, string)

Menghapus perilaku untuk jenis item kerja proses.

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

Parameter

processId

string

ID proses

witRefNameForBehaviors

string

Nama referensi jenis item kerja untuk perilaku

behaviorRefName

string

Nama referensi perilaku

Mengembalikan

Promise<void>

removeControlFromGroup(string, string, string, string)

Menghapus kontrol dari formulir item kerja

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

Parameter

processId

string

ID proses

witRefName

string

Nama referensi jenis item kerja

groupId

string

ID grup

controlId

string

ID kontrol yang akan dihapus

Mengembalikan

Promise<void>

removeFieldFromWorkItemType(string, string, string)

Menghapus bidang dalam jenis item kerja proses.

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

Parameter

processId

string

ID proses

witRefNameForFields

string

Nama referensi jenis item kerja untuk bidang

fieldRefName

string

Nama referensi bidang

Mengembalikan

Promise<void>

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

Menghapus grup dari formulir item kerja

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

Parameter

processId

string

ID proses

witRefName

string

Nama referensi jenis item kerja

pageId

string

ID halaman tempat grup berada

sectionId

string

ID bagian ke grup ada di

groupId

string

ID grup

Mengembalikan

Promise<void>

removePage(string, string, string)

Menghapus halaman dari formulir item kerja

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

Parameter

processId

string

ID proses

witRefName

string

Nama referensi jenis item kerja

pageId

string

ID halaman

Mengembalikan

Promise<void>

replaceBehavior(BehaviorReplaceModel, string, string)

Menggantikan perilaku dalam prosesnya.

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

Parameter

behaviorData

BehaviorReplaceModel

processId

string

ID proses

behaviorId

string

ID perilaku

Mengembalikan

Promise<BehaviorModel>

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

Memindahkan kontrol ke grup baru

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

Parameter

control

Control

Kontrol

processId

string

ID proses

witRefName

string

Nama referensi jenis item kerja

groupId

string

ID grup untuk memindahkan kontrol

controlId

string

ID kontrol

removeFromGroupId

string

Grup untuk menghapus kontrol

Mengembalikan

Promise<Control>

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

Memindahkan grup ke halaman dan bagian yang berbeda

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

Parameter

group

Group

Grup yang diperbarui

processId

string

ID proses

witRefName

string

Nama referensi jenis item kerja

pageId

string

ID halaman tempat grup berada

sectionId

string

ID bagian tempat grup berada

groupId

string

ID grup

removeFromPageId

string

ID halaman untuk menghapus grup

removeFromSectionId

string

ID bagian untuk menghapus grup

Mengembalikan

Promise<Group>

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

Memindahkan grup ke bagian lain

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

Parameter

group

Group

Grup yang diperbarui

processId

string

ID proses

witRefName

string

Nama referensi jenis item kerja

pageId

string

ID halaman tempat grup berada

sectionId

string

ID bagian tempat grup berada

groupId

string

ID grup

removeFromSectionId

string

ID bagian untuk menghapus grup

Mengembalikan

Promise<Group>

updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)

Memperbarui jenis item kerja default untuk perilaku proses.

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

Parameter

behavior

WorkItemTypeBehavior

processId

string

ID proses

witRefNameForBehaviors

string

Nama referensi jenis item kerja untuk perilaku

Mengembalikan

Promise<WorkItemTypeBehavior>

updateField(FieldUpdate, string)

Memperbarui bidang tertentu dalam proses.

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

Parameter

field

FieldUpdate

processId

string

ID proses

Mengembalikan

Promise<FieldModel>

updateList(PickListModel, string)

Memperbarui daftar.

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

Parameter

picklist

PickListModel

listId

string

ID daftar

Mengembalikan

Promise<PickListModel>

updateStateDefinition(WorkItemStateInputModel, string, string, string)

Memperbarui definisi status tertentu dalam jenis item kerja proses.

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

Parameter

stateModel

WorkItemStateInputModel

processId

string

ID proses

witRefName

string

Nama referensi jenis item kerja

stateId

string

ID negara bagian

Mengembalikan

Promise<WorkItemStateResultModel>

updateWorkItemType(WorkItemTypeUpdateModel, string, string)

Memperbarui jenis item kerja proses.

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

Parameter

workItemTypeUpdate

WorkItemTypeUpdateModel

processId

string

ID proses

witRefName

string

Nama referensi jenis item kerja

Mengembalikan

Promise<WorkItemTypeModel>

updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)

Memperbarui satu bidang dalam cakupan proses dan jenis item kerja yang diberikan.

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

Parameter

field

WorkItemTypeFieldModel2

Model yang digunakan untuk memperbarui bidang

processId

string

ID proses

witRefNameForFields

string

Nama referensi jenis item kerja untuk bidang

Mengembalikan

Promise<WorkItemTypeFieldModel2>