WorkItemTrackingProcessRestClient class
Kelas dasar yang harus digunakan (berasal dari) untuk membuat permintaan ke API VSS REST
- Extends
new WorkItemTrackingProcessRestClient(options: IVssRestClientOptions)
Parameter
- options
- IVssRestClientOptions
static RESOURCE_AREA_ID: string
Nilai Properti
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>
Menambahkan bidang ke tipe item kerja.
function addFieldToWorkItemType(field: AddProcessWorkItemTypeFieldRequest, processId: string, witRefName: string): Promise<ProcessWorkItemTypeField>
Parameter
- processId
-
string
ID proses.
- witRefName
-
string
Nama referensi jenis item kerja.
Mengembalikan
Promise<ProcessWorkItemTypeField>
Menambahkan grup ke formulir item kerja.
function addGroup(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string): Promise<Group>
Parameter
- group
- Group
Grup.
- 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>
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>
Menambahkan aturan untuk bekerja tipe item dalam proses.
function addProcessWorkItemTypeRule(processRuleCreate: CreateProcessRuleRequest, processId: string, witRefName: string): Promise<ProcessRule>
Parameter
- processRuleCreate
- CreateProcessRuleRequest
- processId
-
string
ID proses
- witRefName
-
string
Nama referensi jenis item kerja
Mengembalikan
Promise<ProcessRule>
Membuat kontrol dalam grup.
function createControlInGroup(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>
Membuat daftar pilihan.
function createList(picklist: PickList): Promise<PickList>
Parameter
- picklist
- PickList
Daftar pilihan
Mengembalikan
Promise<PickList>
Membuat proses.
function createNewProcess(createRequest: CreateProcessModel): Promise<ProcessInfo>
Parameter
- createRequest
- CreateProcessModel
CreateProcessModel.
Mengembalikan
Promise<ProcessInfo>
Membuat satu perilaku dalam proses yang diberikan.
function createProcessBehavior(behavior: ProcessBehaviorCreateRequest, processId: string): Promise<ProcessBehavior>
Parameter
- behavior
- ProcessBehaviorCreateRequest
- processId
-
string
ID proses
Mengembalikan
Promise<ProcessBehavior>
Membuat tipe item kerja dalam proses.
function createProcessWorkItemType(workItemType: CreateProcessWorkItemTypeRequest, processId: string): Promise<ProcessWorkItemType>
Parameter
- workItemType
- CreateProcessWorkItemTypeRequest
- processId
-
string
ID proses untuk membuat jenis item kerja.
Mengembalikan
Promise<ProcessWorkItemType>
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>
Menghapus daftar pilihan.
function deleteList(listId: string): Promise<void>
Parameter
- listId
-
string
ID daftar
Mengembalikan
Promise<void>
Menghapus perilaku dalam proses.
function deleteProcessBehavior(processId: string, behaviorRefName: string): Promise<void>
Parameter
- processId
-
string
ID proses
- behaviorRefName
-
string
Nama referensi perilaku
Mengembalikan
Promise<void>
Menghapus proses ID tertentu.
function deleteProcessById(processTypeId: string): Promise<void>
Parameter
- processTypeId
-
string
Mengembalikan
Promise<void>
Menghapus tipe item kerja dalam proses.
function deleteProcessWorkItemType(processId: string, witRefName: string): Promise<void>
Parameter
- processId
-
string
ID proses.
- witRefName
-
string
Nama referensi jenis item kerja.
Mengembalikan
Promise<void>
Menghapus aturan dari jenis item kerja dalam proses.
function deleteProcessWorkItemTypeRule(processId: string, witRefName: string, ruleId: string): Promise<void>
Parameter
- processId
-
string
ID proses
- witRefName
-
string
Nama referensi jenis item kerja
- ruleId
-
string
ID aturan
Mengembalikan
Promise<void>
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 status
Mengembalikan
Promise<void>
Menghapus modifikasi kontrol sistem pada formulir item kerja.
function deleteSystemControl(processId: string, witRefName: string, controlId: string): Promise<Control[]>
Parameter
- processId
-
string
ID proses.
- witRefName
-
string
Nama referensi jenis item kerja.
- controlId
-
string
ID kontrol.
Mengembalikan
Promise<Control[]>
Edit proses ID tertentu.
function editProcess(updateRequest: UpdateProcessModel, processTypeId: string): Promise<ProcessInfo>
Parameter
- updateRequest
- UpdateProcessModel
- processTypeId
-
string
Mengembalikan
Promise<ProcessInfo>
Mengembalikan daftar semua bidang dalam tipe item kerja.
function getAllWorkItemTypeFields(processId: string, witRefName: string): Promise<ProcessWorkItemTypeField[]>
Parameter
- processId
-
string
ID proses.
- witRefName
-
string
Nama referensi jenis item kerja.
Mengembalikan
Promise<ProcessWorkItemTypeField[]>
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>
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[]>
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>
Mengembalikan daftar pilih.
function getList(listId: string): Promise<PickList>
Parameter
- listId
-
string
ID daftar
Mengembalikan
Promise<PickList>
Dapatkan daftar semua proses termasuk sistem dan diwariskan.
function getListOfProcesses(expand?: GetProcessExpandLevel): Promise<ProcessInfo[]>
Parameter
- expand
- GetProcessExpandLevel
Mengembalikan
Promise<ProcessInfo[]>
Mengembalikan meta data dari daftar pilihan.
function getListsMetadata(): Promise<PickListMetadata[]>
Mengembalikan
Promise<PickListMetadata[]>
Mengembalikan perilaku proses.
function getProcessBehavior(processId: string, behaviorRefName: string, expand?: GetBehaviorsExpand): Promise<ProcessBehavior>
Parameter
- processId
-
string
ID proses
- behaviorRefName
-
string
Nama referensi perilaku
- expand
- GetBehaviorsExpand
Mengembalikan
Promise<ProcessBehavior>
Mengembalikan daftar semua perilaku dalam proses.
function getProcessBehaviors(processId: string, expand?: GetBehaviorsExpand): Promise<ProcessBehavior[]>
Parameter
- processId
-
string
ID proses
- expand
- GetBehaviorsExpand
Mengembalikan
Promise<ProcessBehavior[]>
Dapatkan satu proses DARI ID tertentu.
function getProcessByItsId(processTypeId: string, expand?: GetProcessExpandLevel): Promise<ProcessInfo>
Parameter
- processTypeId
-
string
- expand
- GetProcessExpandLevel
Mengembalikan
Promise<ProcessInfo>
Mengembalikan satu jenis item kerja dalam sebuah proses.
function getProcessWorkItemType(processId: string, witRefName: string, expand?: GetWorkItemTypeExpand): Promise<ProcessWorkItemType>
Parameter
- processId
-
string
ID proses
- witRefName
-
string
Nama referensi jenis item kerja
- expand
- GetWorkItemTypeExpand
Bendera untuk menentukan properti jenis item kerja apa yang akan dikembalikan
Mengembalikan
Promise<ProcessWorkItemType>
Mengembalikan satu aturan dalam jenis item kerja proses.
function getProcessWorkItemTypeRule(processId: string, witRefName: string, ruleId: string): Promise<ProcessRule>
Parameter
- processId
-
string
ID proses
- witRefName
-
string
Nama referensi jenis item kerja
- ruleId
-
string
ID aturan
Mengembalikan
Promise<ProcessRule>
Mengembalikan daftar semua aturan dalam jenis item kerja proses.
function getProcessWorkItemTypeRules(processId: string, witRefName: string): Promise<ProcessRule[]>
Parameter
- processId
-
string
ID proses
- witRefName
-
string
Nama referensi jenis item kerja
Mengembalikan
Promise<ProcessRule[]>
Mengembalikan daftar semua jenis item kerja dalam sebuah proses.
function getProcessWorkItemTypes(processId: string, expand?: GetWorkItemTypeExpand): Promise<ProcessWorkItemType[]>
Parameter
- processId
-
string
ID proses
- expand
- GetWorkItemTypeExpand
Bendera untuk menentukan properti jenis item kerja apa yang akan dikembalikan
Mengembalikan
Promise<ProcessWorkItemType[]>
Mengembalikan definisi status tunggal 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 status
Mengembalikan
Promise<WorkItemStateResultModel>
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[]>
Mendapatkan kontrol sistem yang diedit untuk jenis item kerja dalam proses. Untuk mendapatkan semua kontrol sistem (basis + diedit) gunakan API tata letak
function getSystemControls(processId: string, witRefName: string): Promise<Control[]>
Parameter
- processId
-
string
ID proses.
- witRefName
-
string
Nama referensi jenis item kerja.
Mengembalikan
Promise<Control[]>
Mengembalikan bidang dalam jenis item kerja.
function getWorkItemTypeField(processId: string, witRefName: string, fieldRefName: string, expand?: ProcessWorkItemTypeFieldsExpandLevel): Promise<ProcessWorkItemTypeField>
Parameter
- processId
-
string
ID proses.
- witRefName
-
string
Nama referensi jenis item kerja.
- fieldRefName
-
string
Nama referensi bidang.
Mengembalikan
Promise<ProcessWorkItemTypeField>
Menyembunyikan definisi status dalam tipe item kerja proses. Hanya status dengan customizationType:System yang dapat disembunyikan.
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 status
Mengembalikan
Promise<WorkItemStateResultModel>
Memindahkan kontrol ke grup tertentu.
function moveControlToGroup(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
ID grup untuk menghapus kontrol.
Mengembalikan
Promise<Control>
Memindahkan grup ke halaman dan bagian lain.
function moveGroupToPage(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 grup adalah i.n
- groupId
-
string
ID grup.
- removeFromPageId
-
string
ID halaman untuk menghapus grup.
- removeFromSectionId
-
string
ID bagian untuk menghapus grup.
Mengembalikan
Promise<Group>
Memindahkan grup ke bagian lain.
function moveGroupToSection(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>
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>
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>
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 untuk grup berada di
- groupId
-
string
ID grup
Mengembalikan
Promise<void>
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>
Menghapus bidang dari tipe item kerja. Tidak menghapus bidang secara permanen.
function removeWorkItemTypeField(processId: string, witRefName: string, fieldRefName: string): Promise<void>
Parameter
- processId
-
string
ID proses.
- witRefName
-
string
Nama referensi jenis item kerja.
- fieldRefName
-
string
Nama referensi bidang.
Mengembalikan
Promise<void>
Updates perilaku untuk jenis item kerja 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>
Updates kontrol pada formulir item kerja.
function updateControl(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>
Updates grup dalam formulir item kerja.
function updateGroup(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>
Updates daftar.
function updateList(picklist: PickList, listId: string): Promise<PickList>
Parameter
- picklist
- PickList
- listId
-
string
ID daftar
Mengembalikan
Promise<PickList>
Updates halaman pada formulir item kerja
function updatePage(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>
Menggantikan perilaku dalam proses.
function updateProcessBehavior(behaviorData: ProcessBehaviorUpdateRequest, processId: string, behaviorRefName: string): Promise<ProcessBehavior>
Parameter
- behaviorData
- ProcessBehaviorUpdateRequest
- processId
-
string
ID proses
- behaviorRefName
-
string
Nama referensi perilaku
Mengembalikan
Promise<ProcessBehavior>
Updates jenis item kerja proses.
function updateProcessWorkItemType(workItemTypeUpdate: UpdateProcessWorkItemTypeRequest, processId: string, witRefName: string): Promise<ProcessWorkItemType>
Parameter
- workItemTypeUpdate
- UpdateProcessWorkItemTypeRequest
- processId
-
string
ID proses
- witRefName
-
string
Nama referensi jenis item kerja
Mengembalikan
Promise<ProcessWorkItemType>
Updates aturan dalam jenis item kerja proses.
function updateProcessWorkItemTypeRule(processRule: UpdateProcessRuleRequest, processId: string, witRefName: string, ruleId: string): Promise<ProcessRule>
Parameter
- processRule
- UpdateProcessRuleRequest
- processId
-
string
ID proses
- witRefName
-
string
Nama referensi jenis item kerja
- ruleId
-
string
ID aturan
Mengembalikan
Promise<ProcessRule>
Updates 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 status
Mengembalikan
Promise<WorkItemStateResultModel>
Updates/menambahkan kontrol sistem pada formulir item kerja.
function updateSystemControl(control: Control, processId: string, witRefName: string, controlId: string): Promise<Control>
Parameter
- control
- Control
- processId
-
string
ID proses.
- witRefName
-
string
Nama referensi jenis item kerja.
- controlId
-
string
ID kontrol.
Mengembalikan
Promise<Control>
Updates bidang dalam jenis item kerja.
function updateWorkItemTypeField(field: UpdateProcessWorkItemTypeFieldRequest, processId: string, witRefName: string, fieldRefName: string): Promise<ProcessWorkItemTypeField>
Parameter
- processId
-
string
ID proses.
- witRefName
-
string
Nama referensi jenis item kerja.
- fieldRefName
-
string
Nama referensi bidang.
Mengembalikan
Promise<ProcessWorkItemTypeField>