WorkRestClient class
الفئة الأساسية التي يجب استخدامها (مشتقة من) لتقديم طلبات إلى VSS REST apis
- Extends
static RESOURCE_AREA_ID: stringقيمة الخاصية
string
إضافة خطة جديدة للفريق
function createPlan(postedPlan: CreatePlan, project: string): Promise<Plan>المعلمات
- postedPlan
- CreatePlan
تعريف الخطة
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<Plan>
حذف الخطة المحددة
function deletePlan(project: string, id: string): Promise<void>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- id
-
string
معرف الخطة
المرتجعات
Promise<void>
حذف تكرار الفريق بواسطة iterationId
function deleteTeamIteration(teamContext: TeamContext, id: string): Promise<void>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
- id
-
string
معرف التكرار
المرتجعات
Promise<void>
الحصول على مستوى تراكم
function getBacklog(teamContext: TeamContext, id: string): Promise<BacklogLevelConfiguration>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
- id
-
string
معرف مستوى التراكم
المرتجعات
Promise<BacklogLevelConfiguration>
الحصول على تكوين تراكم لفريق
function getBacklogConfigurations(teamContext: TeamContext): Promise<BacklogConfiguration>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
المرتجعات
Promise<BacklogConfiguration>
الحصول على قائمة بعناصر العمل ضمن مستوى تراكم
function getBacklogLevelWorkItems(teamContext: TeamContext, backlogId: string): Promise<BacklogLevelWorkItems>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
- backlogId
-
string
المرتجعات
Promise<BacklogLevelWorkItems>
سرد جميع مستويات التراكم
function getBacklogs(teamContext: TeamContext): Promise<BacklogLevelConfiguration[]>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
المرتجعات
Promise<BacklogLevelConfiguration[]>
الحصول على اللوحة
function getBoard(teamContext: TeamContext, id: string): Promise<Board>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
- id
-
string
معرف اللوحة، إما اسم مستوى تراكم اللوحة (على سبيل المثال: "القصص") أو المعرف
المرتجعات
Promise<Board>
يحصل على شارة تعرض حالة الأعمدة على اللوحة.
function getBoardBadge(teamContext: TeamContext, id: string, columnOptions?: BoardBadgeColumnOptions, columns?: string[]): Promise<BoardBadge>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
- id
-
string
معرف اللوحة.
- columnOptions
- BoardBadgeColumnOptions
تحديد الأعمدة التي يجب إظهارها.
- columns
-
string[]
إذا تم تعيين columnOptions إلى مخصص، فحدد قائمة أسماء الأعمدة.
المرتجعات
Promise<BoardBadge>
يحصل على شارة تعرض حالة الأعمدة على اللوحة.
function getBoardBadgeData(teamContext: TeamContext, id: string, columnOptions?: BoardBadgeColumnOptions, columns?: string[]): Promise<string>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
- id
-
string
معرف اللوحة.
- columnOptions
- BoardBadgeColumnOptions
تحديد الأعمدة التي يجب إظهارها.
- columns
-
string[]
إذا تم تعيين columnOptions إلى مخصص، فحدد قائمة أسماء الأعمدة.
المرتجعات
Promise<string>
الحصول على إعدادات قاعدة بطاقة اللوحة لمعرف اللوحة أو اللوحة حسب الاسم
function getBoardCardRuleSettings(teamContext: TeamContext, board: string): Promise<BoardCardRuleSettings>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
- board
-
string
المرتجعات
Promise<BoardCardRuleSettings>
الحصول على إعدادات بطاقة اللوحة لمعرف اللوحة أو اللوحة حسب الاسم
function getBoardCardSettings(teamContext: TeamContext, board: string): Promise<BoardCardSettings>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
- board
-
string
المرتجعات
Promise<BoardCardSettings>
الحصول على مخطط لوحي
function getBoardChart(teamContext: TeamContext, board: string, name: string): Promise<BoardChart>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
- board
-
string
معرف اللوحة، إما اسم مستوى تراكم اللوحة (على سبيل المثال: "القصص") أو المعرف
- name
-
string
اسم المخطط
المرتجعات
Promise<BoardChart>
الحصول على مخططات اللوحة
function getBoardCharts(teamContext: TeamContext, board: string): Promise<BoardChartReference[]>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
- board
-
string
معرف اللوحة، إما اسم مستوى تراكم اللوحة (على سبيل المثال: "القصص") أو المعرف
المرتجعات
Promise<BoardChartReference[]>
الحصول على أعمدة على لوحة
function getBoardColumns(teamContext: TeamContext, board: string): Promise<BoardColumn[]>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
- board
-
string
اسم أو معرف اللوحة المحددة
المرتجعات
Promise<BoardColumn[]>
إرجاع قائمة نموذج عامل تصفية الحقل الأصل لقائمة معرفات workitem المحددة
function getBoardMappingParentItems(teamContext: TeamContext, childBacklogContextCategoryRefName: string, workitemIds: number[]): Promise<ParentChildWIMap[]>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
- childBacklogContextCategoryRefName
-
string
- workitemIds
-
number[]
المرتجعات
Promise<ParentChildWIMap[]>
الحصول على صفوف على لوحة
function getBoardRows(teamContext: TeamContext, board: string): Promise<BoardRow[]>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
- board
-
string
اسم أو معرف اللوحة المحددة
المرتجعات
Promise<BoardRow[]>
الحصول على لوحات
function getBoards(teamContext: TeamContext): Promise<BoardReference[]>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
المرتجعات
Promise<BoardReference[]>
الحصول على إعدادات مستخدم اللوحة لمعرف اللوحة
function getBoardUserSettings(teamContext: TeamContext, board: string): Promise<BoardUserSettings>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
- board
-
string
معرف اللوحة أو الاسم
المرتجعات
Promise<BoardUserSettings>
الحصول على سعة الفريق بما في ذلك إجمالي السعة وأيام العطلة
function getCapacitiesWithIdentityRefAndTotals(teamContext: TeamContext, iterationId: string): Promise<TeamCapacity>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
- iterationId
-
string
معرف التكرار
المرتجعات
Promise<TeamCapacity>
الحصول على سعة عضو الفريق
function getCapacityWithIdentityRef(teamContext: TeamContext, iterationId: string, teamMemberId: string): Promise<TeamMemberCapacityIdentityRef>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
- iterationId
-
string
معرف التكرار
- teamMemberId
-
string
معرف عضو الفريق
المرتجعات
Promise<TeamMemberCapacityIdentityRef>
function getColumns(teamContext: TeamContext): Promise<TaskboardColumns>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
المرتجعات
Promise<TaskboardColumns>
الحصول على أعمدة اللوحة المتوفرة في مشروع
function getColumnSuggestedValues(project?: string): Promise<BoardSuggestedValue[]>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<BoardSuggestedValue[]>
الحصول على بيانات طريقة عرض التسليم
function getDeliveryTimelineData(project: string, id: string, revision?: number, startDate?: Date, endDate?: Date): Promise<DeliveryViewData>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- id
-
string
معرف طريقة عرض التسليم
- revision
-
number
مراجعة الخطة التي تريد البيانات لها. إذا كانت الخطة الحالية مراجعة مختلفة، فستحصل على استثناء ViewRevisionMismatchException. إذا لم تقم بتوفير مراجعة، فستحصل على بيانات لآخر مراجعة.
- startDate
-
Date
تاريخ بدء المخطط الزمني
- endDate
-
Date
تاريخ انتهاء المخطط الزمني
المرتجعات
Promise<DeliveryViewData>
الحصول على عناصر العمل للتكرار
function getIterationWorkItems(teamContext: TeamContext, iterationId: string): Promise<IterationWorkItems>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
- iterationId
-
string
معرف التكرار
المرتجعات
Promise<IterationWorkItems>
الحصول على معلومات الخطة المحددة
function getPlan(project: string, id: string): Promise<Plan>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- id
-
string
معرف الخطة
المرتجعات
Promise<Plan>
الحصول على المعلومات لجميع الخطط التي تم تكوينها للفريق المحدد
function getPlans(project: string): Promise<Plan[]>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<Plan[]>
الحصول على تكوين العملية
function getProcessConfiguration(project: string): Promise<ProcessConfiguration>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<ProcessConfiguration>
الحصول على صفوف اللوحة المتوفرة في مشروع
function getRowSuggestedValues(project?: string): Promise<BoardSuggestedValue[]>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<BoardSuggestedValue[]>
الحصول على أيام عطلة الفريق للتكرار
function getTeamDaysOff(teamContext: TeamContext, iterationId: string): Promise<TeamSettingsDaysOff>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
- iterationId
-
string
معرف التكرار
المرتجعات
Promise<TeamSettingsDaysOff>
الحصول على مجموعة من قيم حقول الفريق
function getTeamFieldValues(teamContext: TeamContext): Promise<TeamFieldValues>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
المرتجعات
Promise<TeamFieldValues>
الحصول على تكرار الفريق حسب معرف التكرار
function getTeamIteration(teamContext: TeamContext, id: string): Promise<TeamSettingsIteration>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
- id
-
string
معرف التكرار
المرتجعات
Promise<TeamSettingsIteration>
الحصول على تكرارات الفريق باستخدام عامل تصفية الإطار الزمني
function getTeamIterations(teamContext: TeamContext, timeframe?: string): Promise<TeamSettingsIteration[]>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
- timeframe
-
string
عامل تصفية يتم إرجاع التكرارات له استنادا إلى الوقت النسبي. الحالي فقط مدعوم حاليا.
المرتجعات
Promise<TeamSettingsIteration[]>
الحصول على إعدادات الفريق
function getTeamSettings(teamContext: TeamContext): Promise<TeamSetting>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
المرتجعات
Promise<TeamSetting>
الحصول على سعة التكرار لجميع الفرق في التكرار
function getTotalIterationCapacities(project: string, iterationId: string): Promise<IterationCapacity>المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- iterationId
-
string
معرف التكرار
المرتجعات
Promise<IterationCapacity>
function getWorkItemColumns(teamContext: TeamContext, iterationId: string): Promise<TaskboardWorkItemColumn[]>المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
- iterationId
-
string
المرتجعات
Promise<TaskboardWorkItemColumn[]>
إضافة تكرار إلى الفريق
function postTeamIteration(iteration: TeamSettingsIteration, teamContext: TeamContext): Promise<TeamSettingsIteration>المعلمات
- iteration
- TeamSettingsIteration
التكرار المراد إضافته
- teamContext
- TeamContext
سياق الفريق للعملية
المرتجعات
Promise<TeamSettingsIteration>
إعادة ترتيب عناصر عمل تراكم المنتج/اللوحات
function reorderBacklogWorkItems(operation: ReorderOperation, teamContext: TeamContext): Promise<ReorderResult[]>المعلمات
- operation
- ReorderOperation
- teamContext
- TeamContext
سياق الفريق للعملية
المرتجعات
Promise<ReorderResult[]>
إعادة ترتيب تراكم الدورات المتكررة/عناصر عمل لوحة المهام
function reorderIterationWorkItems(operation: ReorderOperation, teamContext: TeamContext, iterationId: string): Promise<ReorderResult[]>المعلمات
- operation
- ReorderOperation
- teamContext
- TeamContext
سياق الفريق للعملية
- iterationId
-
string
معرف التكرار
المرتجعات
Promise<ReorderResult[]>
استبدال سعة الفريق
function replaceCapacitiesWithIdentityRef(capacities: TeamMemberCapacityIdentityRef[], teamContext: TeamContext, iterationId: string): Promise<TeamMemberCapacityIdentityRef[]>المعلمات
- capacities
قدرة الفريق على الاستبدال
- teamContext
- TeamContext
سياق الفريق للعملية
- iterationId
-
string
معرف التكرار
المرتجعات
Promise<TeamMemberCapacityIdentityRef[]>
تحديث خيارات اللوحة
function setBoardOptions(options: {[key: string]: string}, teamContext: TeamContext, id: string): Promise<{[key: string]: string}>المعلمات
- options
-
{[key: string]: string}
خيارات للتحديث
- teamContext
- TeamContext
سياق الفريق للعملية
- id
-
string
معرف اللوحة، إما اسم الفئة الجمع (على سبيل المثال: "القصص") أو guid
المرتجعات
Promise<{[key: string]: string}>
إنشاء/تحديث إعدادات قواعد التنفيذ التلقائي
function updateAutomationRule(ruleRequestModel: TeamAutomationRulesSettingsRequestModel, teamContext: TeamContext): Promise<void>المعلمات
- ruleRequestModel
- TeamAutomationRulesSettingsRequestModel
المعلمات المطلوبة لإنشاء/تحديث إعدادات قواعد التنفيذ التلقائي
- teamContext
- TeamContext
سياق الفريق للعملية
المرتجعات
Promise<void>
تحديث إعدادات قاعدة بطاقة اللوحة لمعرف اللوحة أو اللوحة بالاسم
function updateBoardCardRuleSettings(boardCardRuleSettings: BoardCardRuleSettings, teamContext: TeamContext, board: string): Promise<BoardCardRuleSettings>المعلمات
- boardCardRuleSettings
- BoardCardRuleSettings
- teamContext
- TeamContext
سياق الفريق للعملية
- board
-
string
المرتجعات
Promise<BoardCardRuleSettings>
تحديث إعدادات بطاقة اللوحة لمعرف اللوحة أو اللوحة بالاسم
function updateBoardCardSettings(boardCardSettingsToSave: BoardCardSettings, teamContext: TeamContext, board: string): Promise<BoardCardSettings>المعلمات
- boardCardSettingsToSave
- BoardCardSettings
- teamContext
- TeamContext
سياق الفريق للعملية
- board
-
string
المرتجعات
Promise<BoardCardSettings>
تحديث مخطط لوحي
function updateBoardChart(chart: BoardChart, teamContext: TeamContext, board: string, name: string): Promise<BoardChart>المعلمات
- chart
- BoardChart
- teamContext
- TeamContext
سياق الفريق للعملية
- board
-
string
معرف اللوحة، إما اسم مستوى تراكم اللوحة (على سبيل المثال: "القصص") أو المعرف
- name
-
string
اسم المخطط
المرتجعات
Promise<BoardChart>
تحديث الأعمدة على لوحة
function updateBoardColumns(boardColumns: BoardColumn[], teamContext: TeamContext, board: string): Promise<BoardColumn[]>المعلمات
- boardColumns
قائمة أعمدة اللوحة المراد تحديثها
- teamContext
- TeamContext
سياق الفريق للعملية
- board
-
string
اسم أو معرف لوحة معينة
المرتجعات
Promise<BoardColumn[]>
تحديث الصفوف على لوحة
function updateBoardRows(boardRows: BoardRow[], teamContext: TeamContext, board: string): Promise<BoardRow[]>المعلمات
- boardRows
-
BoardRow[]
قائمة صفوف اللوحة المراد تحديثها
- teamContext
- TeamContext
سياق الفريق للعملية
- board
-
string
اسم أو معرف لوحة معينة
المرتجعات
Promise<BoardRow[]>
تحديث إعدادات مستخدم اللوحة لمعرف اللوحة
function updateBoardUserSettings(boardUserSettings: {[key: string]: string}, teamContext: TeamContext, board: string): Promise<BoardUserSettings>المعلمات
- boardUserSettings
-
{[key: string]: string}
- teamContext
- TeamContext
سياق الفريق للعملية
- board
-
string
المرتجعات
Promise<BoardUserSettings>
تحديث سعة عضو الفريق
function updateCapacityWithIdentityRef(patch: CapacityPatch, teamContext: TeamContext, iterationId: string, teamMemberId: string): Promise<TeamMemberCapacityIdentityRef>المعلمات
- patch
- CapacityPatch
السعة المحدثة
- teamContext
- TeamContext
سياق الفريق للعملية
- iterationId
-
string
معرف التكرار
- teamMemberId
-
string
معرف عضو الفريق
المرتجعات
Promise<TeamMemberCapacityIdentityRef>
function updateColumns(updateColumns: UpdateTaskboardColumn[], teamContext: TeamContext): Promise<TaskboardColumns>المعلمات
- updateColumns
- teamContext
- TeamContext
سياق الفريق للعملية
المرتجعات
Promise<TaskboardColumns>
تحديث معلومات الخطة المحددة
function updatePlan(updatedPlan: UpdatePlan, project: string, id: string): Promise<Plan>المعلمات
- updatedPlan
- UpdatePlan
تعريف الخطة المراد تحديثه
- project
-
string
معرف المشروع أو اسم المشروع
- id
-
string
معرف الخطة
المرتجعات
Promise<Plan>
تحديث إعدادات قاعدة بطاقة لوحة المهام
function updateTaskboardCardRuleSettings(boardCardRuleSettings: BoardCardRuleSettings, teamContext: TeamContext): Promise<void>المعلمات
- boardCardRuleSettings
- BoardCardRuleSettings
- teamContext
- TeamContext
سياق الفريق للعملية
المرتجعات
Promise<void>
تحديث إعدادات بطاقة لوحة المهام
function updateTaskboardCardSettings(boardCardSettingsToSave: BoardCardSettings, teamContext: TeamContext): Promise<void>المعلمات
- boardCardSettingsToSave
- BoardCardSettings
- teamContext
- TeamContext
سياق الفريق للعملية
المرتجعات
Promise<void>
تعيين أيام عطلة الفريق للتكرار
function updateTeamDaysOff(daysOffPatch: TeamSettingsDaysOffPatch, teamContext: TeamContext, iterationId: string): Promise<TeamSettingsDaysOff>المعلمات
- daysOffPatch
- TeamSettingsDaysOffPatch
تصحيح أيام توقف الفريق الذي يحتوي على قائمة بتواريخ البدء والانتهاء
- teamContext
- TeamContext
سياق الفريق للعملية
- iterationId
-
string
معرف التكرار
المرتجعات
Promise<TeamSettingsDaysOff>
تحديث قيم حقول الفريق
function updateTeamFieldValues(patch: TeamFieldValuesPatch, teamContext: TeamContext): Promise<TeamFieldValues>المعلمات
- patch
- TeamFieldValuesPatch
- teamContext
- TeamContext
سياق الفريق للعملية
المرتجعات
Promise<TeamFieldValues>
تحديث إعدادات الفريق
function updateTeamSettings(teamSettingsPatch: TeamSettingsPatch, teamContext: TeamContext): Promise<TeamSetting>المعلمات
- teamSettingsPatch
- TeamSettingsPatch
تغييرات TeamSettings
- teamContext
- TeamContext
سياق الفريق للعملية
المرتجعات
Promise<TeamSetting>
function updateWorkItemColumn(updateColumn: UpdateTaskboardWorkItemColumn, teamContext: TeamContext, iterationId: string, workItemId: number): Promise<void>المعلمات
- updateColumn
- UpdateTaskboardWorkItemColumn
- teamContext
- TeamContext
سياق الفريق للعملية
- iterationId
-
string
- workItemId
-
number
المرتجعات
Promise<void>