WorkRestClient class

الحزمة:: azure-devops-extension-api

الفئة الأساسية التي يجب استخدامها (مشتقة من) لتقديم طلبات إلى VSS REST apis

يمتد: RestClientBase

المنشئون

الخصائص

الأساليب

createPlan(CreatePlan, string)	إضافة خطة جديدة للفريق
deletePlan(string, string)	حذف الخطة المحددة
deleteTeamIteration(TeamContext, string)	حذف تكرار فريق بواسطة iterationId
getBacklog(TeamContext, string)	الحصول على مستوى تراكمي
getBacklogConfigurations(TeamContext)	الحصول على تكوين الأعمال المتراكمة لفريق
getBacklogLevelWorkItems(TeamContext, string)	الحصول على قائمة بعناصر العمل ضمن مستوى تراكم
getBacklogs(TeamContext)	سرد جميع مستويات الأعمال المتراكمة
getBoard(TeamContext, string)	احصل على اللوحة
getBoardBadge(TeamContext, string, BoardBadgeColumnOptions, string[])	يحصل على شارة تعرض حالة الأعمدة على اللوحة.
getBoardBadgeData(TeamContext, string, BoardBadgeColumnOptions, string[])	يحصل على شارة تعرض حالة الأعمدة على اللوحة.
getBoardCardRuleSettings(TeamContext, string)	الحصول على إعدادات قاعدة بطاقة اللوحة لمعرف اللوحة أو اللوحة بالاسم
getBoardCardSettings(TeamContext, string)	احصل على إعدادات بطاقة اللوحة لمعرف اللوحة أو اللوحة بالاسم
getBoardChart(TeamContext, string, string)	احصل على مخطط لوحة
getBoardCharts(TeamContext, string)	احصل على مخططات اللوحة
getBoardColumns(TeamContext, string)	الحصول على أعمدة على لوحة
getBoardMappingParentItems(TeamContext, string, number[])	إرجاع قائمة نموذج عامل تصفية الحقول الأصلية للقائمة المحددة لمعرفات عنصر العمل
getBoardRows(TeamContext, string)	الحصول على صفوف على السبورة
getBoards(TeamContext)	احصل على لوحات
getBoardUserSettings(TeamContext, string)	الحصول على إعدادات مستخدم اللوحة لمعرف اللوحة
getCapacitiesWithIdentityRefAndTotals(TeamContext, string)	احصل على سعة الفريق بما في ذلك السعة الإجمالية وأيام الإجازة
getCapacityWithIdentityRef(TeamContext, string, string)	الحصول على سعة عضو الفريق
getColumns(TeamContext)
getColumnSuggestedValues(string)	الحصول على أعمدة اللوحة المتوفرة في مشروع
getDeliveryTimelineData(string, string, number, Date, Date)	احصل على بيانات عرض التسليم
getIterationWorkItems(TeamContext, string)	الحصول على عناصر العمل للتكرار
getPlan(string, string)	الحصول على معلومات الخطة المحددة
getPlans(string)	الحصول على معلومات لجميع الخطط التي تم تكوينها للفريق المحدد
getProcessConfiguration(string)	الحصول على تكوين العملية
getRowSuggestedValues(string)	الحصول على صفوف اللوحة المتوفرة في مشروع
getTeamDaysOff(TeamContext, string)	احصل على أيام إجازة للفريق للتكرار
getTeamFieldValues(TeamContext)	الحصول على مجموعة من قيم حقل الفريق
getTeamIteration(TeamContext, string)	الحصول على تكرار الفريق عن طريق iterationId
getTeamIterations(TeamContext, string)	احصل على تكرارات الفريق باستخدام عامل تصفية الإطار الزمني
getTeamSettings(TeamContext)	الحصول على إعدادات الفريق
getTotalIterationCapacities(string, string)	احصل على سعة التكرار لجميع الفرق في التكرار
getWorkItemColumns(TeamContext, string)
postTeamIteration(TeamSettingsIteration, TeamContext)	إضافة تكرار إلى الفريق
reorderBacklogWorkItems(ReorderOperation, TeamContext)	إعادة ترتيب عناصر عمل تراكم المنتج / اللوحات
reorderIterationWorkItems(ReorderOperation, TeamContext, string)	إعادة ترتيب Sprint Backlog/عناصر عمل لوحة المهام
replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)	استبدال سعة الفريق
setBoardOptions({[key: string]: string}, TeamContext, string)	تحديث خيارات اللوحة
updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)	ينشئ/يحدث/يقوم بتحديث إعدادات قواعد الأتمتة
updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)	تحديث إعدادات قاعدة بطاقة اللوحة لمعرف اللوحة أو اللوحة حسب الاسم
updateBoardCardSettings(BoardCardSettings, TeamContext, string)	تحديث إعدادات بطاقة اللوحة لمعرف اللوحة أو اللوحة بالاسم
updateBoardChart(BoardChart, TeamContext, string, string)	تحديث مخطط اللوحة
updateBoardColumns(BoardColumn[], TeamContext, string)	تحديث الأعمدة على اللوحة
updateBoardRows(BoardRow[], TeamContext, string)	تحديث الصفوف على لوحة
updateBoardUserSettings({[key: string]: string}, TeamContext, string)	تحديث إعدادات مستخدم اللوحة لمعرف اللوحة
updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)	تحديث سعة عضو الفريق
updateColumns(UpdateTaskboardColumn[], TeamContext)
updatePlan(UpdatePlan, string, string)	تحديث المعلومات الخاصة بالخطة المحددة
updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)	تحديث إعدادات قاعدة بطاقة لوحة المهام
updateTaskboardCardSettings(BoardCardSettings, TeamContext)	تحديث إعدادات بطاقة لوحة المهام
updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)	حدد أيام إجازة الفريق للتكرار
updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)	تحديث قيم حقل الفريق
updateTeamSettings(TeamSettingsPatch, TeamContext)	تحديث إعدادات الفريق
updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

تفاصيل المنشئ

WorkRestClient(IVssRestClientOptions)

new WorkRestClient(options: IVssRestClientOptions)

المعلمات

options: IVssRestClientOptions

تفاصيل الخاصية

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

قيمة الخاصية

string

تفاصيل الأسلوب

createPlan(CreatePlan, string)

إضافة خطة جديدة للفريق

function createPlan(postedPlan: CreatePlan, project: string): Promise<Plan>

المعلمات

postedPlan: CreatePlan

تعريف الخطة

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<Plan>

deletePlan(string, string)

حذف الخطة المحددة

function deletePlan(project: string, id: string): Promise<void>

المعلمات

project: string

معرف المشروع أو اسم المشروع

id: string

معرف الخطة

المرتجعات

Promise<void>

deleteTeamIteration(TeamContext, string)

حذف تكرار فريق بواسطة iterationId

function deleteTeamIteration(teamContext: TeamContext, id: string): Promise<void>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

id: string

معرف التكرار

المرتجعات

Promise<void>

getBacklog(TeamContext, string)

الحصول على مستوى تراكمي

function getBacklog(teamContext: TeamContext, id: string): Promise<BacklogLevelConfiguration>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

id: string

معرف مستوى الأعمال المتراكمة

المرتجعات

Promise<BacklogLevelConfiguration>

getBacklogConfigurations(TeamContext)

الحصول على تكوين الأعمال المتراكمة لفريق

function getBacklogConfigurations(teamContext: TeamContext): Promise<BacklogConfiguration>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

المرتجعات

Promise<BacklogConfiguration>

getBacklogLevelWorkItems(TeamContext, string)

الحصول على قائمة بعناصر العمل ضمن مستوى تراكم

function getBacklogLevelWorkItems(teamContext: TeamContext, backlogId: string): Promise<BacklogLevelWorkItems>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

backlogId: string

المرتجعات

Promise<BacklogLevelWorkItems>

getBacklogs(TeamContext)

سرد جميع مستويات الأعمال المتراكمة

function getBacklogs(teamContext: TeamContext): Promise<BacklogLevelConfiguration[]>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

المرتجعات

Promise<BacklogLevelConfiguration[]>

getBoard(TeamContext, string)

احصل على اللوحة

function getBoard(teamContext: TeamContext, id: string): Promise<Board>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

id: string

معرف اللوحة ، إما اسم مستوى تراكم اللوحة (على سبيل المثال: "القصص") أو المعرف

المرتجعات

Promise<Board>

getBoardBadge(TeamContext, string, BoardBadgeColumnOptions, string[])

يحصل على شارة تعرض حالة الأعمدة على اللوحة.

function getBoardBadge(teamContext: TeamContext, id: string, columnOptions?: BoardBadgeColumnOptions, columns?: string[]): Promise<BoardBadge>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

id: string

معرف اللوحة.

columnOptions: BoardBadgeColumnOptions

يحدد الأعمدة المراد إظهارها.

columns: string[]

إذا تم تعيين columnOptions إلى مخصص، فحدد قائمة أسماء الأعمدة.

المرتجعات

Promise<BoardBadge>

getBoardBadgeData(TeamContext, string, BoardBadgeColumnOptions, string[])

يحصل على شارة تعرض حالة الأعمدة على اللوحة.

function getBoardBadgeData(teamContext: TeamContext, id: string, columnOptions?: BoardBadgeColumnOptions, columns?: string[]): Promise<string>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

id: string

معرف اللوحة.

columnOptions: BoardBadgeColumnOptions

يحدد الأعمدة المراد إظهارها.

columns: string[]

إذا تم تعيين columnOptions إلى مخصص، فحدد قائمة أسماء الأعمدة.

المرتجعات

Promise<string>

getBoardCardRuleSettings(TeamContext, string)

الحصول على إعدادات قاعدة بطاقة اللوحة لمعرف اللوحة أو اللوحة بالاسم

function getBoardCardRuleSettings(teamContext: TeamContext, board: string): Promise<BoardCardRuleSettings>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

board: string

المرتجعات

Promise<BoardCardRuleSettings>

getBoardCardSettings(TeamContext, string)

احصل على إعدادات بطاقة اللوحة لمعرف اللوحة أو اللوحة بالاسم

function getBoardCardSettings(teamContext: TeamContext, board: string): Promise<BoardCardSettings>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

board: string

المرتجعات

Promise<BoardCardSettings>

getBoardChart(TeamContext, string, string)

احصل على مخطط لوحة

function getBoardChart(teamContext: TeamContext, board: string, name: string): Promise<BoardChart>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

board: string

معرف اللوحة ، إما اسم مستوى تراكم اللوحة (على سبيل المثال: "القصص") أو المعرف

name: string

اسم الرسم البياني

المرتجعات

Promise<BoardChart>

getBoardCharts(TeamContext, string)

احصل على مخططات اللوحة

function getBoardCharts(teamContext: TeamContext, board: string): Promise<BoardChartReference[]>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

board: string

معرف اللوحة ، إما اسم مستوى تراكم اللوحة (على سبيل المثال: "القصص") أو المعرف

المرتجعات

Promise<BoardChartReference[]>

getBoardColumns(TeamContext, string)

الحصول على أعمدة على لوحة

function getBoardColumns(teamContext: TeamContext, board: string): Promise<BoardColumn[]>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

board: string

اسم أو هوية اللوحة المحددة

المرتجعات

Promise<BoardColumn[]>

getBoardMappingParentItems(TeamContext, string, number[])

إرجاع قائمة نموذج عامل تصفية الحقول الأصلية للقائمة المحددة لمعرفات عنصر العمل

function getBoardMappingParentItems(teamContext: TeamContext, childBacklogContextCategoryRefName: string, workitemIds: number[]): Promise<ParentChildWIMap[]>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

childBacklogContextCategoryRefName: string

workitemIds: number[]

المرتجعات

Promise<ParentChildWIMap[]>

getBoardRows(TeamContext, string)

الحصول على صفوف على السبورة

function getBoardRows(teamContext: TeamContext, board: string): Promise<BoardRow[]>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

board: string

اسم أو هوية اللوحة المحددة

المرتجعات

Promise<BoardRow[]>

getBoards(TeamContext)

احصل على لوحات

function getBoards(teamContext: TeamContext): Promise<BoardReference[]>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

المرتجعات

Promise<BoardReference[]>

getBoardUserSettings(TeamContext, string)

الحصول على إعدادات مستخدم اللوحة لمعرف اللوحة

function getBoardUserSettings(teamContext: TeamContext, board: string): Promise<BoardUserSettings>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

board: string

معرف المجلس أو الاسم

المرتجعات

Promise<BoardUserSettings>

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

احصل على سعة الفريق بما في ذلك السعة الإجمالية وأيام الإجازة

function getCapacitiesWithIdentityRefAndTotals(teamContext: TeamContext, iterationId: string): Promise<TeamCapacity>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

iterationId: string

معرف التكرار

المرتجعات

Promise<TeamCapacity>

getCapacityWithIdentityRef(TeamContext, string, string)

الحصول على سعة عضو الفريق

function getCapacityWithIdentityRef(teamContext: TeamContext, iterationId: string, teamMemberId: string): Promise<TeamMemberCapacityIdentityRef>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

iterationId: string

معرف التكرار

teamMemberId: string

هوية عضو الفريق

المرتجعات

Promise<TeamMemberCapacityIdentityRef>

getColumns(TeamContext)

function getColumns(teamContext: TeamContext): Promise<TaskboardColumns>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

المرتجعات

Promise<TaskboardColumns>

getColumnSuggestedValues(string)

الحصول على أعمدة اللوحة المتوفرة في مشروع

function getColumnSuggestedValues(project?: string): Promise<BoardSuggestedValue[]>

المعلمات

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<BoardSuggestedValue[]>

getDeliveryTimelineData(string, string, number, Date, Date)

احصل على بيانات عرض التسليم

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>

getIterationWorkItems(TeamContext, string)

الحصول على عناصر العمل للتكرار

function getIterationWorkItems(teamContext: TeamContext, iterationId: string): Promise<IterationWorkItems>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

iterationId: string

معرف التكرار

المرتجعات

Promise<IterationWorkItems>

getPlan(string, string)

الحصول على معلومات الخطة المحددة

function getPlan(project: string, id: string): Promise<Plan>

المعلمات

project: string

معرف المشروع أو اسم المشروع

id: string

معرف الخطة

المرتجعات

Promise<Plan>

getPlans(string)

الحصول على معلومات لجميع الخطط التي تم تكوينها للفريق المحدد

function getPlans(project: string): Promise<Plan[]>

المعلمات

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<Plan[]>

getProcessConfiguration(string)

الحصول على تكوين العملية

function getProcessConfiguration(project: string): Promise<ProcessConfiguration>

المعلمات

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<ProcessConfiguration>

getRowSuggestedValues(string)

الحصول على صفوف اللوحة المتوفرة في مشروع

function getRowSuggestedValues(project?: string): Promise<BoardSuggestedValue[]>

المعلمات

project: string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<BoardSuggestedValue[]>

getTeamDaysOff(TeamContext, string)

احصل على أيام إجازة للفريق للتكرار

function getTeamDaysOff(teamContext: TeamContext, iterationId: string): Promise<TeamSettingsDaysOff>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

iterationId: string

معرف التكرار

المرتجعات

Promise<TeamSettingsDaysOff>

getTeamFieldValues(TeamContext)

الحصول على مجموعة من قيم حقل الفريق

function getTeamFieldValues(teamContext: TeamContext): Promise<TeamFieldValues>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

المرتجعات

Promise<TeamFieldValues>

getTeamIteration(TeamContext, string)

الحصول على تكرار الفريق عن طريق iterationId

function getTeamIteration(teamContext: TeamContext, id: string): Promise<TeamSettingsIteration>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

id: string

معرف التكرار

المرتجعات

Promise<TeamSettingsIteration>

getTeamIterations(TeamContext, string)

احصل على تكرارات الفريق باستخدام عامل تصفية الإطار الزمني

function getTeamIterations(teamContext: TeamContext, timeframe?: string): Promise<TeamSettingsIteration[]>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

timeframe: string

عامل تصفية يتم إرجاع التكرارات له استنادا إلى الوقت النسبي. يتم دعم Current فقط حاليا.

المرتجعات

Promise<TeamSettingsIteration[]>

getTeamSettings(TeamContext)

الحصول على إعدادات الفريق

function getTeamSettings(teamContext: TeamContext): Promise<TeamSetting>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

المرتجعات

Promise<TeamSetting>

getTotalIterationCapacities(string, string)

احصل على سعة التكرار لجميع الفرق في التكرار

function getTotalIterationCapacities(project: string, iterationId: string): Promise<IterationCapacity>

المعلمات

project: string

معرف المشروع أو اسم المشروع

iterationId: string

معرف التكرار

المرتجعات

Promise<IterationCapacity>

getWorkItemColumns(TeamContext, string)

function getWorkItemColumns(teamContext: TeamContext, iterationId: string): Promise<TaskboardWorkItemColumn[]>

المعلمات

teamContext: TeamContext

سياق الفريق للعملية

iterationId: string

المرتجعات

Promise<TaskboardWorkItemColumn[]>

postTeamIteration(TeamSettingsIteration, TeamContext)

إضافة تكرار إلى الفريق

function postTeamIteration(iteration: TeamSettingsIteration, teamContext: TeamContext): Promise<TeamSettingsIteration>

المعلمات

iteration: TeamSettingsIteration

التكرار للإضافة

teamContext: TeamContext

سياق الفريق للعملية

المرتجعات

Promise<TeamSettingsIteration>

reorderBacklogWorkItems(ReorderOperation, TeamContext)

إعادة ترتيب عناصر عمل تراكم المنتج / اللوحات

function reorderBacklogWorkItems(operation: ReorderOperation, teamContext: TeamContext): Promise<ReorderResult[]>

المعلمات

operation: ReorderOperation

teamContext: TeamContext

سياق الفريق للعملية

المرتجعات

Promise<ReorderResult[]>

reorderIterationWorkItems(ReorderOperation, TeamContext, string)

إعادة ترتيب Sprint Backlog/عناصر عمل لوحة المهام

function reorderIterationWorkItems(operation: ReorderOperation, teamContext: TeamContext, iterationId: string): Promise<ReorderResult[]>

المعلمات

operation: ReorderOperation

teamContext: TeamContext

سياق الفريق للعملية

iterationId: string

معرف التكرار

المرتجعات

Promise<ReorderResult[]>

replaceCapacitiesWithIdentityRef(TeamMemberCapacityIdentityRef[], TeamContext, string)

استبدال سعة الفريق

function replaceCapacitiesWithIdentityRef(capacities: TeamMemberCapacityIdentityRef[], teamContext: TeamContext, iterationId: string): Promise<TeamMemberCapacityIdentityRef[]>

المعلمات

capacities: TeamMemberCapacityIdentityRef[]

قدرة الفريق على استبدال

teamContext: TeamContext

سياق الفريق للعملية

iterationId: string

معرف التكرار

المرتجعات

Promise<TeamMemberCapacityIdentityRef[]>

setBoardOptions({[key: string]: string}, TeamContext, string)

تحديث خيارات اللوحة

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}>

updateAutomationRule(TeamAutomationRulesSettingsRequestModel, TeamContext)

ينشئ/يحدث/يقوم بتحديث إعدادات قواعد الأتمتة

function updateAutomationRule(ruleRequestModel: TeamAutomationRulesSettingsRequestModel, teamContext: TeamContext): Promise<void>

المعلمات

ruleRequestModel: TeamAutomationRulesSettingsRequestModel

المعلمات المطلوبة لإنشاء / تحديث إعدادات قواعد الأتمتة

teamContext: TeamContext

سياق الفريق للعملية

المرتجعات

Promise<void>

updateBoardCardRuleSettings(BoardCardRuleSettings, TeamContext, string)

تحديث إعدادات قاعدة بطاقة اللوحة لمعرف اللوحة أو اللوحة حسب الاسم

function updateBoardCardRuleSettings(boardCardRuleSettings: BoardCardRuleSettings, teamContext: TeamContext, board: string): Promise<BoardCardRuleSettings>

المعلمات

boardCardRuleSettings: BoardCardRuleSettings

teamContext: TeamContext

سياق الفريق للعملية

board: string

المرتجعات

Promise<BoardCardRuleSettings>

updateBoardCardSettings(BoardCardSettings, TeamContext, string)

تحديث إعدادات بطاقة اللوحة لمعرف اللوحة أو اللوحة بالاسم

function updateBoardCardSettings(boardCardSettingsToSave: BoardCardSettings, teamContext: TeamContext, board: string): Promise<BoardCardSettings>

المعلمات

boardCardSettingsToSave: BoardCardSettings

teamContext: TeamContext

سياق الفريق للعملية

board: string

المرتجعات

Promise<BoardCardSettings>

updateBoardChart(BoardChart, TeamContext, string, string)

تحديث مخطط اللوحة

function updateBoardChart(chart: BoardChart, teamContext: TeamContext, board: string, name: string): Promise<BoardChart>

المعلمات

chart: BoardChart

teamContext: TeamContext

سياق الفريق للعملية

board: string

معرف اللوحة ، إما اسم مستوى تراكم اللوحة (على سبيل المثال: "القصص") أو المعرف

name: string

اسم الرسم البياني

المرتجعات

Promise<BoardChart>

updateBoardColumns(BoardColumn[], TeamContext, string)

تحديث الأعمدة على اللوحة

function updateBoardColumns(boardColumns: BoardColumn[], teamContext: TeamContext, board: string): Promise<BoardColumn[]>

المعلمات

boardColumns: BoardColumn[]

قائمة أعمدة اللوحة المراد تحديثها

teamContext: TeamContext

سياق الفريق للعملية

board: string

اسم أو هوية اللوحة المحددة

المرتجعات

Promise<BoardColumn[]>

updateBoardRows(BoardRow[], TeamContext, string)

تحديث الصفوف على لوحة

function updateBoardRows(boardRows: BoardRow[], teamContext: TeamContext, board: string): Promise<BoardRow[]>

المعلمات

boardRows: BoardRow[]

قائمة صفوف اللوحة المطلوب تحديثها

teamContext: TeamContext

سياق الفريق للعملية

board: string

اسم أو هوية اللوحة المحددة

المرتجعات

Promise<BoardRow[]>

updateBoardUserSettings({[key: string]: string}, TeamContext, string)

تحديث إعدادات مستخدم اللوحة لمعرف اللوحة

function updateBoardUserSettings(boardUserSettings: {[key: string]: string}, teamContext: TeamContext, board: string): Promise<BoardUserSettings>

المعلمات

boardUserSettings: {[key: string]: string}

teamContext: TeamContext

سياق الفريق للعملية

board: string

المرتجعات

Promise<BoardUserSettings>

updateCapacityWithIdentityRef(CapacityPatch, TeamContext, string, string)

تحديث سعة عضو الفريق

function updateCapacityWithIdentityRef(patch: CapacityPatch, teamContext: TeamContext, iterationId: string, teamMemberId: string): Promise<TeamMemberCapacityIdentityRef>

المعلمات

patch: CapacityPatch

السعة المحدثة

teamContext: TeamContext

سياق الفريق للعملية

iterationId: string

معرف التكرار

teamMemberId: string

هوية عضو الفريق

المرتجعات

Promise<TeamMemberCapacityIdentityRef>

updateColumns(UpdateTaskboardColumn[], TeamContext)

function updateColumns(updateColumns: UpdateTaskboardColumn[], teamContext: TeamContext): Promise<TaskboardColumns>

المعلمات

updateColumns: UpdateTaskboardColumn[]

teamContext: TeamContext

سياق الفريق للعملية

المرتجعات

Promise<TaskboardColumns>

updatePlan(UpdatePlan, string, string)

تحديث المعلومات الخاصة بالخطة المحددة

function updatePlan(updatedPlan: UpdatePlan, project: string, id: string): Promise<Plan>

المعلمات

updatedPlan: UpdatePlan

سيتم تحديث تعريف الخطة

project: string

معرف المشروع أو اسم المشروع

id: string

معرف الخطة

المرتجعات

Promise<Plan>

updateTaskboardCardRuleSettings(BoardCardRuleSettings, TeamContext)

تحديث إعدادات قاعدة بطاقة لوحة المهام

function updateTaskboardCardRuleSettings(boardCardRuleSettings: BoardCardRuleSettings, teamContext: TeamContext): Promise<void>

المعلمات

boardCardRuleSettings: BoardCardRuleSettings

teamContext: TeamContext

سياق الفريق للعملية

المرتجعات

Promise<void>

updateTaskboardCardSettings(BoardCardSettings, TeamContext)

تحديث إعدادات بطاقة لوحة المهام

function updateTaskboardCardSettings(boardCardSettingsToSave: BoardCardSettings, teamContext: TeamContext): Promise<void>

المعلمات

boardCardSettingsToSave: BoardCardSettings

teamContext: TeamContext

سياق الفريق للعملية

المرتجعات

Promise<void>

updateTeamDaysOff(TeamSettingsDaysOffPatch, TeamContext, string)

حدد أيام إجازة الفريق للتكرار

function updateTeamDaysOff(daysOffPatch: TeamSettingsDaysOffPatch, teamContext: TeamContext, iterationId: string): Promise<TeamSettingsDaysOff>

المعلمات

daysOffPatch: TeamSettingsDaysOffPatch

تصحيح أيام إجازة الفريق الذي يحتوي على قائمة بتواريخ البدء والانتهاء

teamContext: TeamContext

سياق الفريق للعملية

iterationId: string

معرف التكرار

المرتجعات

Promise<TeamSettingsDaysOff>

updateTeamFieldValues(TeamFieldValuesPatch, TeamContext)

تحديث قيم حقل الفريق

function updateTeamFieldValues(patch: TeamFieldValuesPatch, teamContext: TeamContext): Promise<TeamFieldValues>

المعلمات

patch: TeamFieldValuesPatch

teamContext: TeamContext

سياق الفريق للعملية

المرتجعات

Promise<TeamFieldValues>

updateTeamSettings(TeamSettingsPatch, TeamContext)

تحديث إعدادات الفريق

function updateTeamSettings(teamSettingsPatch: TeamSettingsPatch, teamContext: TeamContext): Promise<TeamSetting>

المعلمات

teamSettingsPatch: TeamSettingsPatch

تغييرات إعدادات الفريق

teamContext: TeamContext

سياق الفريق للعملية

المرتجعات

Promise<TeamSetting>

updateWorkItemColumn(UpdateTaskboardWorkItemColumn, TeamContext, string, number)

function updateWorkItemColumn(updateColumn: UpdateTaskboardWorkItemColumn, teamContext: TeamContext, iterationId: string, workItemId: number): Promise<void>

المعلمات

updateColumn: UpdateTaskboardWorkItemColumn

teamContext: TeamContext

سياق الفريق للعملية

iterationId: string

workItemId: number

المرتجعات

Promise<void>

الملاحظات

هل كانت هذه الصفحة مفيدة؟

مشاركة عبر

WorkRestClient class

المنشئون

الخصائص

الأساليب

تفاصيل المنشئ

WorkRestClient(IVssRestClientOptions)

المعلمات

تفاصيل الخاصية

RESOURCE_AREA_ID

قيمة الخاصية

تفاصيل الأسلوب

createPlan(CreatePlan, string)

المعلمات

المرتجعات

deletePlan(string, string)

المعلمات

المرتجعات

deleteTeamIteration(TeamContext, string)

المعلمات

المرتجعات

getBacklog(TeamContext, string)

المعلمات

المرتجعات

getBacklogConfigurations(TeamContext)

المعلمات

المرتجعات

getBacklogLevelWorkItems(TeamContext, string)

المعلمات

المرتجعات

getBacklogs(TeamContext)

المعلمات

المرتجعات

getBoard(TeamContext, string)

المعلمات

المرتجعات

getBoardBadge(TeamContext, string, BoardBadgeColumnOptions, string[])

المعلمات

المرتجعات

getBoardBadgeData(TeamContext, string, BoardBadgeColumnOptions, string[])

المعلمات

المرتجعات

getBoardCardRuleSettings(TeamContext, string)

المعلمات

المرتجعات

getBoardCardSettings(TeamContext, string)

المعلمات

المرتجعات

getBoardChart(TeamContext, string, string)

المعلمات

المرتجعات

getBoardCharts(TeamContext, string)

المعلمات

المرتجعات

getBoardColumns(TeamContext, string)

المعلمات

المرتجعات

getBoardMappingParentItems(TeamContext, string, number[])

المعلمات

المرتجعات

getBoardRows(TeamContext, string)

المعلمات

المرتجعات

getBoards(TeamContext)

المعلمات

المرتجعات

getBoardUserSettings(TeamContext, string)

المعلمات

المرتجعات

getCapacitiesWithIdentityRefAndTotals(TeamContext, string)

المعلمات

المرتجعات

getCapacityWithIdentityRef(TeamContext, string, string)

المعلمات

المرتجعات

getColumns(TeamContext)

المعلمات

المرتجعات

getColumnSuggestedValues(string)

المعلمات