WorkItemTrackingProcessDefinitionsRestClient class
الفئة الأساسية التي يجب استخدامها (مشتقة من) لتقديم طلبات إلى VSS REST apis
- يمتد
الخصائص
| RESOURCE_AREA_ID |
الأساليب
تفاصيل المنشئ
WorkItemTrackingProcessDefinitionsRestClient(IVssRestClientOptions)
new WorkItemTrackingProcessDefinitionsRestClient(options: IVssRestClientOptions)
المعلمات
- options
- IVssRestClientOptions
تفاصيل الخاصية
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: string
قيمة الخاصية
string
تفاصيل الأسلوب
addBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)
يضيف سلوكا إلى نوع عنصر العمل الخاص بالعملية.
function addBehaviorToWorkItemType(behavior: WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior>
المعلمات
- behavior
- WorkItemTypeBehavior
- processId
-
string
معرف العملية
- witRefNameForBehaviors
-
string
الاسم المرجعي لنوع عنصر العمل للسلوك
المرتجعات
Promise<WorkItemTypeBehavior>
addControlToGroup(Control, string, string, string)
إنشاء عنصر تحكم في مجموعة
function addControlToGroup(control: Control, processId: string, witRefName: string, groupId: string): Promise<Control>
المعلمات
- control
- Control
التحكم
- processId
-
string
معرف العملية
- witRefName
-
string
الاسم المرجعي لنوع عنصر العمل
- groupId
-
string
معرف المجموعة المراد إضافة عنصر التحكم إليها
المرتجعات
Promise<Control>
addFieldToWorkItemType(WorkItemTypeFieldModel2, string, string)
يضيف حقلا إلى نوع عنصر العمل في العملية.
function addFieldToWorkItemType(field: WorkItemTypeFieldModel2, processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2>
المعلمات
- field
- WorkItemTypeFieldModel2
- processId
-
string
معرف العملية
- witRefNameForFields
-
string
الاسم المرجعي لنوع عنصر العمل للحقل
المرتجعات
Promise<WorkItemTypeFieldModel2>
addGroup(Group, string, string, string, string)
إضافة مجموعة إلى نموذج عنصر العمل
function addGroup(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string): Promise<Group>
المعلمات
- group
- Group
المجموعة
- processId
-
string
معرف العملية
- witRefName
-
string
الاسم المرجعي لنوع عنصر العمل
- pageId
-
string
معرف الصفحة المراد إضافة المجموعة إليها
- sectionId
-
string
معرف القسم المراد إضافة المجموعة إليه
المرتجعات
Promise<Group>
addPage(Page, string, string)
createBehavior(BehaviorCreateModel, string)
ينشئ سلوكا واحدا في العملية المحددة.
function createBehavior(behavior: BehaviorCreateModel, processId: string): Promise<BehaviorModel>
المعلمات
- behavior
- BehaviorCreateModel
- processId
-
string
معرف العملية
المرتجعات
Promise<BehaviorModel>
createField(FieldModel, string)
ينشئ حقلا واحدا في العملية.
function createField(field: FieldModel, processId: string): Promise<FieldModel>
المعلمات
- field
- FieldModel
- processId
-
string
معرف العملية
المرتجعات
Promise<FieldModel>
createList(PickListModel)
إنشاء قائمة اختيار.
function createList(picklist: PickListModel): Promise<PickListModel>
المعلمات
- picklist
- PickListModel
المرتجعات
Promise<PickListModel>
createStateDefinition(WorkItemStateInputModel, string, string)
إنشاء تعريف حالة في نوع عنصر العمل للعملية.
function createStateDefinition(stateModel: WorkItemStateInputModel, processId: string, witRefName: string): Promise<WorkItemStateResultModel>
المعلمات
- stateModel
- WorkItemStateInputModel
- processId
-
string
معرف العملية
- witRefName
-
string
الاسم المرجعي لنوع عنصر العمل
المرتجعات
Promise<WorkItemStateResultModel>
createWorkItemType(WorkItemTypeModel, string)
ينشئ نوع عنصر عمل في العملية.
function createWorkItemType(workItemType: WorkItemTypeModel, processId: string): Promise<WorkItemTypeModel>
المعلمات
- workItemType
- WorkItemTypeModel
- processId
-
string
معرف العملية
المرتجعات
Promise<WorkItemTypeModel>
deleteBehavior(string, string)
يزيل سلوكا في العملية.
function deleteBehavior(processId: string, behaviorId: string): Promise<void>
المعلمات
- processId
-
string
معرف العملية
- behaviorId
-
string
معرف السلوك
المرتجعات
Promise<void>
deleteList(string)
يزيل قائمة اختيار.
function deleteList(listId: string): Promise<void>
المعلمات
- listId
-
string
معرف القائمة
المرتجعات
Promise<void>
deleteStateDefinition(string, string, string)
يزيل تعريف الحالة في نوع عنصر العمل الخاص بالعملية.
function deleteStateDefinition(processId: string, witRefName: string, stateId: string): Promise<void>
المعلمات
- processId
-
string
معرف العملية
- witRefName
-
string
الاسم المرجعي لنوع عنصر العمل
- stateId
-
string
هوية الدولة
المرتجعات
Promise<void>
deleteWorkItemType(string, string)
يزيل نوع عنصر عمل في العملية.
function deleteWorkItemType(processId: string, witRefName: string): Promise<void>
المعلمات
- processId
-
string
معرف العملية
- witRefName
-
string
الاسم المرجعي لنوع عنصر العمل
المرتجعات
Promise<void>
editControl(Control, string, string, string, string)
تحديث عنصر تحكم في نموذج عنصر العمل
function editControl(control: Control, processId: string, witRefName: string, groupId: string, controlId: string): Promise<Control>
المعلمات
- control
- Control
عنصر التحكم المحدث
- processId
-
string
معرف العملية
- witRefName
-
string
الاسم المرجعي لنوع عنصر العمل
- groupId
-
string
معرف المجموعة
- controlId
-
string
معرف عنصر التحكم
المرتجعات
Promise<Control>
editGroup(Group, string, string, string, string, string)
تحديث مجموعة في نموذج عنصر العمل
function editGroup(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise<Group>
المعلمات
- group
- Group
المجموعة المحدثة
- processId
-
string
معرف العملية
- witRefName
-
string
الاسم المرجعي لنوع عنصر العمل
- pageId
-
string
معرف الصفحة التي توجد بها المجموعة
- sectionId
-
string
معرف القسم الذي توجد فيه المجموعة
- groupId
-
string
معرف المجموعة
المرتجعات
Promise<Group>
editPage(Page, string, string)
getBehavior(string, string)
إرجاع سلوك واحد في العملية.
function getBehavior(processId: string, behaviorId: string): Promise<BehaviorModel>
المعلمات
- processId
-
string
معرف العملية
- behaviorId
-
string
معرف السلوك
المرتجعات
Promise<BehaviorModel>
getBehaviorForWorkItemType(string, string, string)
إرجاع سلوك لنوع عنصر العمل الخاص بالعملية.
function getBehaviorForWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<WorkItemTypeBehavior>
المعلمات
- processId
-
string
معرف العملية
- witRefNameForBehaviors
-
string
الاسم المرجعي لنوع عنصر العمل للسلوك
- behaviorRefName
-
string
الاسم المرجعي للسلوك
المرتجعات
Promise<WorkItemTypeBehavior>
getBehaviors(string)
إرجاع قائمة بجميع السلوكيات في العملية.
function getBehaviors(processId: string): Promise<BehaviorModel[]>
المعلمات
- processId
-
string
معرف العملية
المرتجعات
Promise<BehaviorModel[]>
getBehaviorsForWorkItemType(string, string)
إرجاع قائمة بكافة السلوكيات لنوع عنصر العمل الخاص بالعملية.
function getBehaviorsForWorkItemType(processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior[]>
المعلمات
- processId
-
string
معرف العملية
- witRefNameForBehaviors
-
string
الاسم المرجعي لنوع عنصر العمل للسلوك
المرتجعات
Promise<WorkItemTypeBehavior[]>
getFormLayout(string, string)
الحصول على تخطيط النموذج
function getFormLayout(processId: string, witRefName: string): Promise<FormLayout>
المعلمات
- processId
-
string
معرف العملية
- witRefName
-
string
الاسم المرجعي لنوع عنصر العمل
المرتجعات
Promise<FormLayout>
getList(string)
إرجاع قائمة اختيار.
function getList(listId: string): Promise<PickListModel>
المعلمات
- listId
-
string
معرف القائمة
المرتجعات
Promise<PickListModel>
getListsMetadata()
إرجاع البيانات الوصفية لقائمة الاختيار.
function getListsMetadata(): Promise<PickListMetadataModel[]>
المرتجعات
Promise<PickListMetadataModel[]>
getStateDefinition(string, string, string)
إرجاع تعريف حالة في نوع عنصر العمل للعملية.
function getStateDefinition(processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>
المعلمات
- processId
-
string
معرف العملية
- witRefName
-
string
الاسم المرجعي لنوع عنصر العمل
- stateId
-
string
هوية الدولة
المرتجعات
Promise<WorkItemStateResultModel>
getStateDefinitions(string, string)
إرجاع قائمة بكافة تعريفات الحالة في نوع عنصر العمل الخاص بالعملية.
function getStateDefinitions(processId: string, witRefName: string): Promise<WorkItemStateResultModel[]>
المعلمات
- processId
-
string
معرف العملية
- witRefName
-
string
الاسم المرجعي لنوع عنصر العمل
المرتجعات
Promise<WorkItemStateResultModel[]>
getWorkItemType(string, string, GetWorkItemTypeExpand)
إرجاع نوع عنصر عمل للعملية.
function getWorkItemType(processId: string, witRefName: string, expand?: GetWorkItemTypeExpand): Promise<WorkItemTypeModel>
المعلمات
- processId
-
string
معرف العملية
- witRefName
-
string
الاسم المرجعي لنوع عنصر العمل
- expand
- GetWorkItemTypeExpand
المرتجعات
Promise<WorkItemTypeModel>
getWorkItemTypeField(string, string, string)
إرجاع حقل واحد في نوع عنصر العمل للعملية.
function getWorkItemTypeField(processId: string, witRefNameForFields: string, fieldRefName: string): Promise<WorkItemTypeFieldModel2>
المعلمات
- processId
-
string
معرف العملية
- witRefNameForFields
-
string
الاسم المرجعي لنوع عنصر العمل للحقول
- fieldRefName
-
string
الاسم المرجعي للحقل
المرتجعات
Promise<WorkItemTypeFieldModel2>
getWorkItemTypeFields(string, string)
إرجاع قائمة بكافة الحقول في نوع عنصر العمل الخاص بالعملية.
function getWorkItemTypeFields(processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2[]>
المعلمات
- processId
-
string
معرف العملية
- witRefNameForFields
-
string
الاسم المرجعي لنوع عنصر العمل للحقول
المرتجعات
Promise<WorkItemTypeFieldModel2[]>
getWorkItemTypes(string, GetWorkItemTypeExpand)
إرجاع قائمة بكافة أنواع عناصر العمل في العملية.
function getWorkItemTypes(processId: string, expand?: GetWorkItemTypeExpand): Promise<WorkItemTypeModel[]>
المعلمات
- processId
-
string
معرف العملية
- expand
- GetWorkItemTypeExpand
المرتجعات
Promise<WorkItemTypeModel[]>
hideStateDefinition(HideStateModel, string, string, string)
يخفي تعريف الحالة في نوع عنصر العمل للعملية.
function hideStateDefinition(hideStateModel: HideStateModel, processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>
المعلمات
- hideStateModel
- HideStateModel
- processId
-
string
معرف العملية
- witRefName
-
string
الاسم المرجعي لنوع عنصر العمل
- stateId
-
string
هوية الدولة
المرتجعات
Promise<WorkItemStateResultModel>
removeBehaviorFromWorkItemType(string, string, string)
يزيل سلوكا لنوع عنصر العمل الخاص بالعملية.
function removeBehaviorFromWorkItemType(processId: string, witRefNameForBehaviors: string, behaviorRefName: string): Promise<void>
المعلمات
- processId
-
string
معرف العملية
- witRefNameForBehaviors
-
string
الاسم المرجعي لنوع عنصر العمل للسلوك
- behaviorRefName
-
string
الاسم المرجعي للسلوك
المرتجعات
Promise<void>
removeControlFromGroup(string, string, string, string)
إزالة عنصر تحكم من نموذج عنصر العمل
function removeControlFromGroup(processId: string, witRefName: string, groupId: string, controlId: string): Promise<void>
المعلمات
- processId
-
string
معرف العملية
- witRefName
-
string
الاسم المرجعي لنوع عنصر العمل
- groupId
-
string
معرف المجموعة
- controlId
-
string
معرف عنصر التحكم المراد إزالته
المرتجعات
Promise<void>
removeFieldFromWorkItemType(string, string, string)
إزالة حقل في نوع عنصر العمل الخاص بالعملية.
function removeFieldFromWorkItemType(processId: string, witRefNameForFields: string, fieldRefName: string): Promise<void>
المعلمات
- processId
-
string
معرف العملية
- witRefNameForFields
-
string
الاسم المرجعي لنوع عنصر العمل للحقول
- fieldRefName
-
string
الاسم المرجعي للحقل
المرتجعات
Promise<void>
removeGroup(string, string, string, string, string)
إزالة مجموعة من نموذج عنصر العمل
function removeGroup(processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string): Promise<void>
المعلمات
- processId
-
string
معرف العملية
- witRefName
-
string
الاسم المرجعي لنوع عنصر العمل
- pageId
-
string
معرف الصفحة التي توجد بها المجموعة
- sectionId
-
string
معرف القسم إلى المجموعة موجود في
- groupId
-
string
معرف المجموعة
المرتجعات
Promise<void>
removePage(string, string, string)
إزالة صفحة من نموذج عنصر العمل
function removePage(processId: string, witRefName: string, pageId: string): Promise<void>
المعلمات
- processId
-
string
معرف العملية
- witRefName
-
string
الاسم المرجعي لنوع عنصر العمل
- pageId
-
string
معرف الصفحة
المرتجعات
Promise<void>
replaceBehavior(BehaviorReplaceModel, string, string)
يحل محل سلوك في العملية.
function replaceBehavior(behaviorData: BehaviorReplaceModel, processId: string, behaviorId: string): Promise<BehaviorModel>
المعلمات
- behaviorData
- BehaviorReplaceModel
- processId
-
string
معرف العملية
- behaviorId
-
string
معرف السلوك
المرتجعات
Promise<BehaviorModel>
setControlInGroup(Control, string, string, string, string, string)
نقل عنصر تحكم إلى مجموعة جديدة
function setControlInGroup(control: Control, processId: string, witRefName: string, groupId: string, controlId: string, removeFromGroupId?: string): Promise<Control>
المعلمات
- control
- Control
التحكم
- processId
-
string
معرف العملية
- witRefName
-
string
الاسم المرجعي لنوع عنصر العمل
- groupId
-
string
معرف المجموعة المراد نقل عنصر التحكم إليه
- controlId
-
string
معرف عنصر التحكم
- removeFromGroupId
-
string
المجموعة التي تريد إزالة عنصر التحكم منها
المرتجعات
Promise<Control>
setGroupInPage(Group, string, string, string, string, string, string, string)
نقل مجموعة إلى صفحة وقسم مختلفين
function setGroupInPage(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromPageId: string, removeFromSectionId: string): Promise<Group>
المعلمات
- group
- Group
المجموعة المحدثة
- processId
-
string
معرف العملية
- witRefName
-
string
الاسم المرجعي لنوع عنصر العمل
- pageId
-
string
معرف الصفحة التي توجد بها المجموعة
- sectionId
-
string
معرف القسم الذي توجد فيه المجموعة
- groupId
-
string
معرف المجموعة
- removeFromPageId
-
string
معرف الصفحة المراد إزالة المجموعة منها
- removeFromSectionId
-
string
معرف القسم المراد إزالة المجموعة منه
المرتجعات
Promise<Group>
setGroupInSection(Group, string, string, string, string, string, string)
نقل مجموعة إلى قسم مختلف
function setGroupInSection(group: Group, processId: string, witRefName: string, pageId: string, sectionId: string, groupId: string, removeFromSectionId: string): Promise<Group>
المعلمات
- group
- Group
المجموعة المحدثة
- processId
-
string
معرف العملية
- witRefName
-
string
الاسم المرجعي لنوع عنصر العمل
- pageId
-
string
معرف الصفحة التي توجد بها المجموعة
- sectionId
-
string
معرف القسم الذي توجد فيه المجموعة
- groupId
-
string
معرف المجموعة
- removeFromSectionId
-
string
معرف القسم المراد إزالة المجموعة منه
المرتجعات
Promise<Group>
updateBehaviorToWorkItemType(WorkItemTypeBehavior, string, string)
يقوم بتحديث نوع عنصر العمل الافتراضي لسلوك العملية.
function updateBehaviorToWorkItemType(behavior: WorkItemTypeBehavior, processId: string, witRefNameForBehaviors: string): Promise<WorkItemTypeBehavior>
المعلمات
- behavior
- WorkItemTypeBehavior
- processId
-
string
معرف العملية
- witRefNameForBehaviors
-
string
الاسم المرجعي لنوع عنصر العمل للسلوك
المرتجعات
Promise<WorkItemTypeBehavior>
updateField(FieldUpdate, string)
يقوم بتحديث حقل معين في العملية.
function updateField(field: FieldUpdate, processId: string): Promise<FieldModel>
المعلمات
- field
- FieldUpdate
- processId
-
string
معرف العملية
المرتجعات
Promise<FieldModel>
updateList(PickListModel, string)
تحديث قائمة.
function updateList(picklist: PickListModel, listId: string): Promise<PickListModel>
المعلمات
- picklist
- PickListModel
- listId
-
string
معرف القائمة
المرتجعات
Promise<PickListModel>
updateStateDefinition(WorkItemStateInputModel, string, string, string)
تحديث تعريف حالة معين في نوع عنصر العمل للعملية.
function updateStateDefinition(stateModel: WorkItemStateInputModel, processId: string, witRefName: string, stateId: string): Promise<WorkItemStateResultModel>
المعلمات
- stateModel
- WorkItemStateInputModel
- processId
-
string
معرف العملية
- witRefName
-
string
الاسم المرجعي لنوع عنصر العمل
- stateId
-
string
هوية الدولة
المرتجعات
Promise<WorkItemStateResultModel>
updateWorkItemType(WorkItemTypeUpdateModel, string, string)
تحديث نوع عنصر عمل للعملية.
function updateWorkItemType(workItemTypeUpdate: WorkItemTypeUpdateModel, processId: string, witRefName: string): Promise<WorkItemTypeModel>
المعلمات
- workItemTypeUpdate
- WorkItemTypeUpdateModel
- processId
-
string
معرف العملية
- witRefName
-
string
الاسم المرجعي لنوع عنصر العمل
المرتجعات
Promise<WorkItemTypeModel>
updateWorkItemTypeField(WorkItemTypeFieldModel2, string, string)
يقوم بتحديث حقل واحد في نطاق العملية المحددة ونوع عنصر العمل.
function updateWorkItemTypeField(field: WorkItemTypeFieldModel2, processId: string, witRefNameForFields: string): Promise<WorkItemTypeFieldModel2>
المعلمات
- field
- WorkItemTypeFieldModel2
النموذج الذي يتم من خلاله تحديث الحقل
- processId
-
string
معرف العملية
- witRefNameForFields
-
string
الاسم المرجعي لنوع عنصر العمل للحقول
المرتجعات
Promise<WorkItemTypeFieldModel2>