WorkItemTrackingRestClient class

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

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

يمتد: RestClientBase

المنشئون

WorkItemTrackingRestClient(IVssRestClientOptions)

الخصائص

الأساليب

createAttachment(any, string, string, string, string)	تحميل مرفق.
createField(WorkItemField, string)	إنشاء حقل جديد.
createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	إنشاء عقدة تصنيف موجودة جديدة أو تحديثها.
createQuery(QueryHierarchyItem, string, string, boolean)	إنشاء استعلام أو نقل استعلام.
createTemplate(WorkItemTemplate, string, string)	ينشئ قالبا
createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)	إنشاء عنصر عمل واحد.
deleteClassificationNode(string, TreeStructureGroup, string, number)	حذف عقدة تصنيف موجودة.
deleteField(string, string)	حذف الحقل. لإلغاء حذف ملف ، راجع واجهة برمجة تطبيقات "تحديث الحقل".
deleteQuery(string, string)	حذف استعلام أو مجلد. يؤدي هذا إلى حذف أي تغيير في الإذن على الاستعلام أو المجلد المحذوف وأي من أحفاده إذا كان مجلدا. من المهم ملاحظة أنه لا يمكن استرداد تغييرات الأذونات المحذوفة عند إلغاء حذف الاستعلام أو المجلد.
deleteTemplate(string, string, string)	حذف القالب الذي يحتوي على معرف محدد
deleteWorkItem(number, string, boolean)	حذف عنصر العمل المحدد وإرساله إلى سلة المحذوفات، بحيث يمكن استعادته مرة أخرى، إذا لزم الأمر. اختياريا، إذا تم تعيين معلمة التدمير إلى true، فإنها تدمر عنصر العمل بشكل دائم. تحذير: إذا تم تعيين المعلمة destroy إلى true، فلن تنتقل عناصر العمل المحذوفة بواسطة هذا الأمر إلى سلة المحذوفات ولا توجد طريقة لاستعادتها/استردادها بعد الحذف. يوصى بعدم استخدام هذه المعلمة. إذا قمت بذلك ، فيرجى استخدام هذه المعلمة بحذر شديد.
destroyWorkItem(number, string)	تدمير عنصر العمل المحدد بشكل دائم من سلة المحذوفات. لا يمكن التراجع عن هذا الإجراء.
exportWorkItemTypeDefinition(string, string, boolean)	تصدير نوع عنصر العمل
getAccountMyWorkData(QueryOption)	داخلي فقط: مستخدم من قبل صفحة الحساب الخاص بي. يؤدي هذا إلى إرجاع تفاصيل عناصر عمل الإنجاز والتنفيذ، والتنفيذ، والمتابعات، والنشاط.
getAttachmentContent(string, string, string, boolean)	تنزيل مرفق.
getAttachmentZip(string, string, string, boolean)	تنزيل مرفق.
getClassificationNode(string, TreeStructureGroup, string, number)	يحصل على عقدة التصنيف لمسار عقدة معين.
getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)	يحصل على عقد تصنيف الجذر أو قائمة عقد التصنيف لقائمة معينة من معرفات العقد، لمشروع معين. في حالة توفير معلمة ids ، ستحصل على قائمة بعقد التصنيف لتلك المعرفات. وإلا ستحصل على عقد تصنيف الجذر لهذا المشروع.
getComment(number, number, string)	الحصول على تعليق لعنصر عمل في المراجعة المحددة.
getComments(number, string, number, number, CommentSortOrder)	الحصول على العدد المحدد من التعليقات لعنصر عمل من المراجعة المحددة.
getDeletedWorkItem(number, string)	الحصول على عنصر عمل محذوف من سلة المحذوفات.
getDeletedWorkItems(number[], string)	الحصول على عناصر العمل من سلة المحذوفات، التي تم تحديد معرفاتها في المعلمات
getDeletedWorkItemShallowReferences(string)	الحصول على قائمة بالمعرفات وعناوين URL الخاصة بعناصر العمل المحذوفة في سلة المحذوفات.
getField(string, string)	الحصول على معلومات حول حقل معين.
getFields(string, GetFieldsExpand)	إرجاع معلومات لكافة الحقول. معلمة معرف/اسم المشروع اختيارية.
getQueries(string, QueryExpand, number, boolean)	يحصل على استعلامات الجذر وأطفالهم
getQueriesBatch(QueryBatchGetRequest, string)	الحصول على قائمة بالاستعلامات حسب المعرفات (بحد أقصى 1000)
getQuery(string, string, QueryExpand, number, boolean, boolean)	استرداد استعلام فردي وأطفاله
getQueryResultCount(string, string, string, boolean, number)	الحصول على نتائج الاستعلام بالنظر إلى معرف الاستعلام.
getRecentActivityData()	الحصول على أنشطة عناصر العمل الحديثة
getRecentMentions()	داخلي فقط: مستخدم من قبل صفحة الحساب الخاص بي.
getRelationType(string)	الحصول على تعريف نوع علاقة عنصر العمل.
getRelationTypes()	الحصول على أنواع علاقات عنصر العمل.
getReportingLinksByLinkType(string, string[], string[], string, Date)	الحصول على مجموعة من ارتباطات عناصر العمل
getRevision(number, number, string, WorkItemExpand)	إرجاع عنصر عمل رطب بالكامل للمراجعة المطلوبة
getRevisions(number, string, number, number, WorkItemExpand)	إرجاع قائمة مراجعات عنصر العمل المركب بالكامل، المدرجة في صفحاتها.
getRootNodes(string, number)	يحصل على عقد تصنيف الجذر ضمن المشروع.
getTemplate(string, string, string)	يحصل على القالب بمعرف محدد
getTemplates(string, string, string)	يحصل على قالب
getUpdate(number, number, string)	إرجاع تحديث واحد لعنصر عمل
getUpdates(number, string, number, number)	إرجاع الدلتا بين مراجعات عنصر العمل
getWorkArtifactLinkTypes()	احصل على قائمة بأنواع ارتباطات البيانات الاصطناعية الصادرة التي تتعقب عناصر العمل.
getWorkItem(number, string, string[], Date, WorkItemExpand)	إرجاع عنصر عمل واحد.
getWorkItemIconJson(string, string, number)	احصل على أيقونة عنصر العمل بإعطاء الاسم المألوف ولون الأيقونة.
getWorkItemIcons()	احصل على قائمة بجميع أيقونات عناصر العمل.
getWorkItemIconSvg(string, string, number)	احصل على أيقونة عنصر العمل بإعطاء الاسم المألوف ولون الأيقونة.
getWorkItemIconXaml(string, string, number)	احصل على أيقونة عنصر العمل بإعطاء الاسم المألوف ولون الأيقونة.
getWorkItemNextStatesOnCheckinAction(number[], string)	إرجاع الحالة التالية على معرفات عنصر العمل المحددة.
getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)	إرجاع قائمة بعناصر العمل (بحد أقصى 200)
getWorkItemsBatch(WorkItemBatchGetRequest, string)	الحصول على عناصر العمل لقائمة معرفات عناصر العمل (بحد أقصى 200)
getWorkItemStateColors(string[])	داخلي فقط: سيتم استخدامه لتجربة العمل في حسابي. الحصول على لون حالة نوع عنصر العمل لمشاريع متعددة
getWorkItemTemplate(string, string, string, Date, WorkItemExpand)	إرجاع عنصر عمل واحد من قالب.
getWorkItemType(string, string)	إرجاع تعريف نوع عنصر العمل.
getWorkItemTypeCategories(string)	الحصول على جميع فئات أنواع عناصر العمل.
getWorkItemTypeCategory(string, string)	احصل على فئة نوع عنصر عمل محدد حسب الاسم.
getWorkItemTypeColorAndIcons(string[])	داخلي فقط: يتم استخدامه لموفري الألوان والأيقونات. احصل على لون نوع الذكاء لمشاريع متعددة
getWorkItemTypeColors(string[])	داخلي فقط: سيتم استخدامه لتجربة العمل في حسابي. احصل على لون نوع الذكاء لمشاريع متعددة
getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)	احصل على قائمة بالحقول لنوع عنصر العمل مع مراجع مفصلة.
getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)	احصل على حقل لنوع عنصر عمل مع مراجع مفصلة.
getWorkItemTypes(string)	إرجاع قائمة أنواع عناصر العمل
getWorkItemTypeStates(string, string)	إرجاع أسماء الحالات والألوان لنوع عنصر عمل.
queryById(string, string, string, boolean, number)	الحصول على نتائج الاستعلام بالنظر إلى معرف الاستعلام.
queryByWiql(Wiql, string, string, boolean, number)	يحصل على نتائج الاستعلام بالنظر إلى WIQL الخاص به.
queryWorkItemsForArtifactUris(ArtifactUriQuery, string)	الاستعلامات عن عناصر العمل المرتبطة بقائمة معينة من عنوان URI للعناصر الاصطناعية.
readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)	الحصول على مجموعة من مراجعات عناصر العمل مع خيار تضمين العناصر المحذوفة
readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)	احصل على مجموعة من مراجعات عناصر العمل. يمكن استخدام هذا الطلب إذا كانت قائمة الحقول كبيرة بما يكفي بحيث يمكنها تشغيل عنوان URL فوق حد الطول.
replaceTemplate(WorkItemTemplate, string, string, string)	استبدال محتويات القالب
restoreWorkItem(WorkItemDeleteUpdate, number, string)	يستعيد عنصر العمل المحذوف من سلة المحذوفات.
searchQueries(string, string, number, QueryExpand, boolean)	البحث في جميع طلبات البحث التي يمكن للمستخدم الوصول إليها في المشروع الحالي
sendMail(SendMailBody, string)	طريقة RESTful لإرسال البريد لعناصر العمل المحددة / التي تم الاستعلام عنها.
updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)	تحديث عقدة تصنيف موجودة.
updateField(UpdateWorkItemField, string, string)	تحديث حقل.
updateQuery(QueryHierarchyItem, string, string, boolean)	تحديث استعلام أو مجلد. يتيح لك ذلك تحديث الاستعلامات والمجلدات وإعادة تسميتها ونقلها.
updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)	تحديث عنصر عمل واحد.
updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)	إضافة/تحديث نوع عنصر عمل

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

WorkItemTrackingRestClient(IVssRestClientOptions)

new WorkItemTrackingRestClient(options: IVssRestClientOptions)

المعلمات

options: IVssRestClientOptions

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

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

قيمة الخاصية

string

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

createAttachment(any, string, string, string, string)

تحميل مرفق.

function createAttachment(content: any, project?: string, fileName?: string, uploadType?: string, areaPath?: string): Promise<AttachmentReference>

المعلمات

content: any

المحتوى المطلوب تحميله

project: string

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

fileName: string

اسم الملف

uploadType: string

نوع تحميل المرفقات: بسيط أو مجزأ

areaPath: string

مسار منطقة المشروع المستهدف

المرتجعات

Promise<AttachmentReference>

createField(WorkItemField, string)

إنشاء حقل جديد.

function createField(workItemField: WorkItemField, project?: string): Promise<WorkItemField>

المعلمات

workItemField: WorkItemField

تعريف حقل جديد

project: string

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

المرتجعات

Promise<WorkItemField>

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

إنشاء عقدة تصنيف موجودة جديدة أو تحديثها.

function createOrUpdateClassificationNode(postedNode: WorkItemClassificationNode, project: string, structureGroup: TreeStructureGroup, path?: string): Promise<WorkItemClassificationNode>

المعلمات

postedNode: WorkItemClassificationNode

عقدة للإنشاء أو التحديث.

project: string

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

structureGroup: TreeStructureGroup

مجموعة هيكل عقدة التصنيف أو المنطقة أو التكرار.

path: string

مسار عقدة التصنيف.

المرتجعات

Promise<WorkItemClassificationNode>

createQuery(QueryHierarchyItem, string, string, boolean)

إنشاء استعلام أو نقل استعلام.

function createQuery(postedQuery: QueryHierarchyItem, project: string, query: string, validateWiqlOnly?: boolean): Promise<QueryHierarchyItem>

المعلمات

postedQuery: QueryHierarchyItem

الاستعلام المطلوب إنشاؤه.

project: string

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

query: string

المعرف أو المسار الأصل الذي سيتم إنشاء الاستعلام بموجبه.

validateWiqlOnly: boolean

إذا كنت تريد فقط التحقق من صحة استعلام WIQL الخاص بك دون إنشاء استعلام فعلي، فقم بتعيينه إلى true. الافتراضي هو خطأ.

المرتجعات

Promise<QueryHierarchyItem>

createTemplate(WorkItemTemplate, string, string)

ينشئ قالبا

function createTemplate(template: WorkItemTemplate, project: string, team: string): Promise<WorkItemTemplate>

المعلمات

template: WorkItemTemplate

محتويات القالب

project: string

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

team: string

معرف الفريق أو اسم الفريق

المرتجعات

Promise<WorkItemTemplate>

createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)

إنشاء عنصر عمل واحد.

function createWorkItem(document: JsonPatchDocument, project: string, type: string, validateOnly?: boolean, bypassRules?: boolean, suppressNotifications?: boolean, expand?: WorkItemExpand): Promise<WorkItem>

المعلمات

document: JsonPatchDocument

مستند تصحيح JSON الذي يمثل عنصر العمل

project: string

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

type: string

نوع عنصر العمل لعنصر العمل المراد إنشاؤه

validateOnly: boolean

حدد ما إذا كنت تريد التحقق من صحة التغييرات فقط دون حفظ عنصر العمل

bypassRules: boolean

لا تفرض قواعد نوع عنصر العمل على هذا التحديث

suppressNotifications: boolean

لا تقم بإطلاق أي إشعارات لهذا التغيير

expand: WorkItemExpand

معلمات التوسيع لسمات عنصر العمل. الخيارات الممكنة هي { لا شيء ، العلاقات ، الحقول ، الروابط ، الكل }.

المرتجعات

Promise<WorkItem>

deleteClassificationNode(string, TreeStructureGroup, string, number)

حذف عقدة تصنيف موجودة.

function deleteClassificationNode(project: string, structureGroup: TreeStructureGroup, path?: string, reclassifyId?: number): Promise<void>

المعلمات

project: string

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

structureGroup: TreeStructureGroup

مجموعة هيكل عقدة التصنيف أو المنطقة أو التكرار.

path: string

مسار عقدة التصنيف.

reclassifyId: number

معرف عقدة التصنيف المستهدف لإعادة التصنيف.

المرتجعات

Promise<void>

deleteField(string, string)

حذف الحقل. لإلغاء حذف ملف ، راجع واجهة برمجة تطبيقات "تحديث الحقل".

function deleteField(fieldNameOrRefName: string, project?: string): Promise<void>

المعلمات

fieldNameOrRefName: string

الاسم البسيط للحقل أو اسم المرجع

project: string

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

المرتجعات

Promise<void>

deleteQuery(string, string)

حذف استعلام أو مجلد. يؤدي هذا إلى حذف أي تغيير في الإذن على الاستعلام أو المجلد المحذوف وأي من أحفاده إذا كان مجلدا. من المهم ملاحظة أنه لا يمكن استرداد تغييرات الأذونات المحذوفة عند إلغاء حذف الاستعلام أو المجلد.

function deleteQuery(project: string, query: string): Promise<void>

المعلمات

project: string

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

query: string

معرف أو مسار الاستعلام أو المجلد المراد حذفه.

المرتجعات

Promise<void>

deleteTemplate(string, string, string)

حذف القالب الذي يحتوي على معرف محدد

function deleteTemplate(project: string, team: string, templateId: string): Promise<void>

المعلمات

project: string

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

team: string

معرف الفريق أو اسم الفريق

templateId: string

معرف القالب

المرتجعات

Promise<void>

deleteWorkItem(number, string, boolean)

حذف عنصر العمل المحدد وإرساله إلى سلة المحذوفات، بحيث يمكن استعادته مرة أخرى، إذا لزم الأمر. اختياريا، إذا تم تعيين معلمة التدمير إلى true، فإنها تدمر عنصر العمل بشكل دائم. تحذير: إذا تم تعيين المعلمة destroy إلى true، فلن تنتقل عناصر العمل المحذوفة بواسطة هذا الأمر إلى سلة المحذوفات ولا توجد طريقة لاستعادتها/استردادها بعد الحذف. يوصى بعدم استخدام هذه المعلمة. إذا قمت بذلك ، فيرجى استخدام هذه المعلمة بحذر شديد.

function deleteWorkItem(id: number, project?: string, destroy?: boolean): Promise<WorkItemDelete>

المعلمات

id: number

معرف عنصر العمل المراد حذفه

project: string

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

destroy: boolean

المعلمة الاختيارية، إذا تم تعيينها إلى true، يتم حذف عنصر العمل نهائيا. يرجى ملاحظة ما يلي: إجراء التدمير دائم ولا يمكن التراجع عنه.

المرتجعات

Promise<WorkItemDelete>

destroyWorkItem(number, string)

تدمير عنصر العمل المحدد بشكل دائم من سلة المحذوفات. لا يمكن التراجع عن هذا الإجراء.

function destroyWorkItem(id: number, project?: string): Promise<void>

المعلمات

id: number

معرف عنصر العمل المراد إتلافه نهائيا

project: string

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

المرتجعات

Promise<void>

exportWorkItemTypeDefinition(string, string, boolean)

تصدير نوع عنصر العمل

function exportWorkItemTypeDefinition(project?: string, type?: string, exportGlobalLists?: boolean): Promise<WorkItemTypeTemplate>

المعلمات

project: string

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

type: string

exportGlobalLists: boolean

المرتجعات

Promise<WorkItemTypeTemplate>

getAccountMyWorkData(QueryOption)

داخلي فقط: مستخدم من قبل صفحة الحساب الخاص بي. يؤدي هذا إلى إرجاع تفاصيل عناصر عمل الإنجاز والتنفيذ، والتنفيذ، والمتابعات، والنشاط.

function getAccountMyWorkData(queryOption?: QueryOption): Promise<AccountMyWorkResult>

المعلمات

queryOption: QueryOption

المرتجعات

Promise<AccountMyWorkResult>

getAttachmentContent(string, string, string, boolean)

تنزيل مرفق.

function getAttachmentContent(id: string, project?: string, fileName?: string, download?: boolean): Promise<ArrayBuffer>

المعلمات

id: string

معرف المرفق

project: string

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

fileName: string

اسم الملف

download: boolean

إذا تم تعيينه على <c>true< / c> ، فقم دائما بتنزيل المرفق

المرتجعات

Promise<ArrayBuffer>

getAttachmentZip(string, string, string, boolean)

تنزيل مرفق.

function getAttachmentZip(id: string, project?: string, fileName?: string, download?: boolean): Promise<ArrayBuffer>

المعلمات

id: string

معرف المرفق

project: string

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

fileName: string

اسم الملف

download: boolean

إذا تم تعيينه على <c>true< / c> ، فقم دائما بتنزيل المرفق

المرتجعات

Promise<ArrayBuffer>

getClassificationNode(string, TreeStructureGroup, string, number)

يحصل على عقدة التصنيف لمسار عقدة معين.

function getClassificationNode(project: string, structureGroup: TreeStructureGroup, path?: string, depth?: number): Promise<WorkItemClassificationNode>

المعلمات

project: string

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

structureGroup: TreeStructureGroup

مجموعة هيكل عقدة التصنيف أو المنطقة أو التكرار.

path: string

مسار عقدة التصنيف.

depth: number

عمق الأطفال المراد جلبهم.

المرتجعات

Promise<WorkItemClassificationNode>

getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)

يحصل على عقد تصنيف الجذر أو قائمة عقد التصنيف لقائمة معينة من معرفات العقد، لمشروع معين. في حالة توفير معلمة ids ، ستحصل على قائمة بعقد التصنيف لتلك المعرفات. وإلا ستحصل على عقد تصنيف الجذر لهذا المشروع.

function getClassificationNodes(project: string, ids: number[], depth?: number, errorPolicy?: ClassificationNodesErrorPolicy): Promise<WorkItemClassificationNode[]>

المعلمات

project: string

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

ids: number[]

معرفات عقد تصنيف الأعداد الصحيحة المنفصلة بفواصل. إنه غير مطلوب ، إذا كنت تريد عقد جذر.

depth: number

عمق الأطفال المراد جلبهم.

errorPolicy: ClassificationNodesErrorPolicy

ضع علامة للتعامل مع الأخطاء في الحصول على بعض العقد. الخيارات الممكنة هي فشل وحذف.

المرتجعات

Promise<WorkItemClassificationNode[]>

getComment(number, number, string)

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

function getComment(id: number, revision: number, project?: string): Promise<WorkItemComment>

المعلمات

id: number

معرف عنصر العمل

revision: number

المراجعة التي يجب جلب التعليق من أجلها

project: string

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

المرتجعات

Promise<WorkItemComment>

getComments(number, string, number, number, CommentSortOrder)

الحصول على العدد المحدد من التعليقات لعنصر عمل من المراجعة المحددة.

function getComments(id: number, project?: string, fromRevision?: number, top?: number, order?: CommentSortOrder): Promise<WorkItemComments>

المعلمات

id: number

معرف عنصر العمل

project: string

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

fromRevision: number

المراجعة التي سيتم جلب التعليقات منها (الافتراضي هو 1)

top: number

عدد التعليقات المراد إرجاعها (الافتراضي هو 200)

order: CommentSortOrder

تصاعدي أو تنازلي حسب معرف المراجعة (الافتراضي تصاعدي)

المرتجعات

Promise<WorkItemComments>

getDeletedWorkItem(number, string)

الحصول على عنصر عمل محذوف من سلة المحذوفات.

function getDeletedWorkItem(id: number, project?: string): Promise<WorkItemDelete>

المعلمات

id: number

معرف عنصر العمل المراد إرجاعه

project: string

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

المرتجعات

Promise<WorkItemDelete>

getDeletedWorkItems(number[], string)

الحصول على عناصر العمل من سلة المحذوفات، التي تم تحديد معرفاتها في المعلمات

function getDeletedWorkItems(ids: number[], project?: string): Promise<WorkItemDeleteReference[]>

المعلمات

ids: number[]

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

project: string

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

المرتجعات

Promise<WorkItemDeleteReference[]>

getDeletedWorkItemShallowReferences(string)

الحصول على قائمة بالمعرفات وعناوين URL الخاصة بعناصر العمل المحذوفة في سلة المحذوفات.

function getDeletedWorkItemShallowReferences(project?: string): Promise<WorkItemDeleteShallowReference[]>

المعلمات

project: string

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

المرتجعات

Promise<WorkItemDeleteShallowReference[]>

getField(string, string)

الحصول على معلومات حول حقل معين.

function getField(fieldNameOrRefName: string, project?: string): Promise<WorkItemField>

المعلمات

fieldNameOrRefName: string

الاسم البسيط للحقل أو اسم المرجع

project: string

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

المرتجعات

Promise<WorkItemField>

getFields(string, GetFieldsExpand)

إرجاع معلومات لكافة الحقول. معلمة معرف/اسم المشروع اختيارية.

function getFields(project?: string, expand?: GetFieldsExpand): Promise<WorkItemField[]>

المعلمات

project: string

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

expand: GetFieldsExpand

استخدم ExtensionFields لتضمين حقول الملحق، وإلا استبعدها. ما لم يتم تمكين علامة الميزة لهذه المعلمة، يتم تضمين حقول الملحق دائما.

المرتجعات

Promise<WorkItemField[]>

getQueries(string, QueryExpand, number, boolean)

يحصل على استعلامات الجذر وأطفالهم

function getQueries(project: string, expand?: QueryExpand, depth?: number, includeDeleted?: boolean): Promise<QueryHierarchyItem[]>

المعلمات

project: string

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

expand: QueryExpand

قم بتضمين سلسلة الاستعلام (wiql) والعبارات وأعمدة نتائج الاستعلام وخيارات الفرز في النتائج.

depth: number

في مجلد الاستعلامات، قم بإرجاع الاستعلامات والمجلدات الفرعية إلى هذا العمق.

includeDeleted: boolean

تضمين الاستعلامات والمجلدات المحذوفة

المرتجعات

Promise<QueryHierarchyItem[]>

getQueriesBatch(QueryBatchGetRequest, string)

الحصول على قائمة بالاستعلامات حسب المعرفات (بحد أقصى 1000)

function getQueriesBatch(queryGetRequest: QueryBatchGetRequest, project: string): Promise<QueryHierarchyItem[]>

المعلمات

queryGetRequest: QueryBatchGetRequest

project: string

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

المرتجعات

Promise<QueryHierarchyItem[]>

getQuery(string, string, QueryExpand, number, boolean, boolean)

استرداد استعلام فردي وأطفاله

function getQuery(project: string, query: string, expand?: QueryExpand, depth?: number, includeDeleted?: boolean, useIsoDateFormat?: boolean): Promise<QueryHierarchyItem>

المعلمات

project: string

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

query: string

معرف الاستعلام أو مساره.

expand: QueryExpand

قم بتضمين سلسلة الاستعلام (wiql) والعبارات وأعمدة نتائج الاستعلام وخيارات الفرز في النتائج.

depth: number

في مجلد الاستعلامات، قم بإرجاع الاستعلامات والمجلدات الفرعية إلى هذا العمق.

includeDeleted: boolean

تضمين الاستعلامات والمجلدات المحذوفة

useIsoDateFormat: boolean

سيتم تنسيق عبارات استعلام DateTime باستخدام تنسيق متوافق مع ISO 8601

المرتجعات

Promise<QueryHierarchyItem>

getQueryResultCount(string, string, string, boolean, number)

الحصول على نتائج الاستعلام بالنظر إلى معرف الاستعلام.

function getQueryResultCount(id: string, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<number>

المعلمات

id: string

معرف الاستعلام.

project: string

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

team: string

معرف الفريق أو اسم الفريق

timePrecision: boolean

سواء لاستخدام دقة الوقت أم لا.

top: number

الحد الأقصى لعدد النتائج المراد إرجاعها.

المرتجعات

Promise<number>

getRecentActivityData()

الحصول على أنشطة عناصر العمل الحديثة

function getRecentActivityData(): Promise<AccountRecentActivityWorkItemModel2[]>

المرتجعات

Promise<AccountRecentActivityWorkItemModel2[]>

getRecentMentions()

داخلي فقط: مستخدم من قبل صفحة الحساب الخاص بي.

function getRecentMentions(): Promise<AccountRecentMentionWorkItemModel[]>

المرتجعات

Promise<AccountRecentMentionWorkItemModel[]>

getRelationType(string)

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

function getRelationType(relation: string): Promise<WorkItemRelationType>

المعلمات

relation: string

اسم العلاقة

المرتجعات

Promise<WorkItemRelationType>

getRelationTypes()

الحصول على أنواع علاقات عنصر العمل.

function getRelationTypes(): Promise<WorkItemRelationType[]>

المرتجعات

Promise<WorkItemRelationType[]>

getReportingLinksByLinkType(string, string[], string[], string, Date)

الحصول على مجموعة من ارتباطات عناصر العمل

function getReportingLinksByLinkType(project?: string, linkTypes?: string[], types?: string[], continuationToken?: string, startDateTime?: Date): Promise<ReportingWorkItemLinksBatch>

المعلمات

project: string

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

linkTypes: string[]

قائمة بالأنواع لتصفية النتائج إلى أنواع ارتباطات معينة. حذف هذه المعلمة للحصول على ارتباطات عناصر العمل من جميع أنواع الارتباطات.

types: string[]

قائمة بالأنواع لتصفية النتائج إلى أنواع عناصر عمل معينة. احذف هذه المعلمة للحصول على ارتباطات عناصر العمل لكافة أنواع عناصر العمل.

continuationToken: string

يحدد continuationToken لبدء الدفعة منه. احذف هذه المعلمة للحصول على الدفعة الأولى من الارتباطات.

startDateTime: Date

التاريخ/الوقت المراد استخدامه كنقطة انطلاق لتغييرات الارتباط. سيتم إرجاع تغييرات الارتباط التي حدثت بعد هذا التاريخ/الوقت فقط. لا يمكن استخدامها مع معلمة "العلامة المائية".

المرتجعات

Promise<ReportingWorkItemLinksBatch>

getRevision(number, number, string, WorkItemExpand)

إرجاع عنصر عمل رطب بالكامل للمراجعة المطلوبة

function getRevision(id: number, revisionNumber: number, project?: string, expand?: WorkItemExpand): Promise<WorkItem>

المعلمات

id: number

revisionNumber: number

project: string

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

expand: WorkItemExpand

المرتجعات

Promise<WorkItem>

getRevisions(number, string, number, number, WorkItemExpand)

إرجاع قائمة مراجعات عنصر العمل المركب بالكامل، المدرجة في صفحاتها.

function getRevisions(id: number, project?: string, top?: number, skip?: number, expand?: WorkItemExpand): Promise<WorkItem[]>

المعلمات

id: number

project: string

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

top: number

skip: number

expand: WorkItemExpand

المرتجعات

Promise<WorkItem[]>

getRootNodes(string, number)

يحصل على عقد تصنيف الجذر ضمن المشروع.

function getRootNodes(project: string, depth?: number): Promise<WorkItemClassificationNode[]>

المعلمات

project: string

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

depth: number

عمق الأطفال المراد جلبهم.

المرتجعات

Promise<WorkItemClassificationNode[]>

getTemplate(string, string, string)

يحصل على القالب بمعرف محدد

function getTemplate(project: string, team: string, templateId: string): Promise<WorkItemTemplate>

المعلمات

project: string

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

team: string

معرف الفريق أو اسم الفريق

templateId: string

معرف القالب

المرتجعات

Promise<WorkItemTemplate>

getTemplates(string, string, string)

يحصل على قالب

function getTemplates(project: string, team: string, workitemtypename?: string): Promise<WorkItemTemplateReference[]>

المعلمات

project: string

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

team: string

معرف الفريق أو اسم الفريق

workitemtypename: string

اختياري، عند تحديده، ترجع القوالب لنوع عنصر عمل معين.

المرتجعات

Promise<WorkItemTemplateReference[]>

getUpdate(number, number, string)

إرجاع تحديث واحد لعنصر عمل

function getUpdate(id: number, updateNumber: number, project?: string): Promise<WorkItemUpdate>

المعلمات

id: number

updateNumber: number

project: string

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

المرتجعات

Promise<WorkItemUpdate>

getUpdates(number, string, number, number)

إرجاع الدلتا بين مراجعات عنصر العمل

function getUpdates(id: number, project?: string, top?: number, skip?: number): Promise<WorkItemUpdate[]>

المعلمات

id: number

project: string

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

top: number

skip: number

المرتجعات

Promise<WorkItemUpdate[]>

getWorkArtifactLinkTypes()

احصل على قائمة بأنواع ارتباطات البيانات الاصطناعية الصادرة التي تتعقب عناصر العمل.

function getWorkArtifactLinkTypes(): Promise<WorkArtifactLink[]>

المرتجعات

Promise<WorkArtifactLink[]>

getWorkItem(number, string, string[], Date, WorkItemExpand)

إرجاع عنصر عمل واحد.

function getWorkItem(id: number, project?: string, fields?: string[], asOf?: Date, expand?: WorkItemExpand): Promise<WorkItem>

المعلمات

id: number

معرف عنصر العمل

project: string

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

fields: string[]

قائمة الحقول المطلوبة مفصولة بفواصل

asOf: Date

سلسلة وقت تاريخ AsOf UTC

expand: WorkItemExpand

معلمات التوسيع لسمات عنصر العمل. الخيارات الممكنة هي { لا شيء ، العلاقات ، الحقول ، الروابط ، الكل }.

المرتجعات

Promise<WorkItem>

getWorkItemIconJson(string, string, number)

احصل على أيقونة عنصر العمل بإعطاء الاسم المألوف ولون الأيقونة.

function getWorkItemIconJson(icon: string, color?: string, v?: number): Promise<WorkItemIcon>

المعلمات

icon: string

اسم الرمز

color: string

اللون السداسي المكون من 6 أرقام للأيقونة

v: number

إصدار الرمز (يستخدم فقط لإبطال ذاكرة التخزين المؤقت)

المرتجعات

Promise<WorkItemIcon>

getWorkItemIcons()

احصل على قائمة بجميع أيقونات عناصر العمل.

function getWorkItemIcons(): Promise<WorkItemIcon[]>

المرتجعات

Promise<WorkItemIcon[]>

getWorkItemIconSvg(string, string, number)

احصل على أيقونة عنصر العمل بإعطاء الاسم المألوف ولون الأيقونة.

function getWorkItemIconSvg(icon: string, color?: string, v?: number): Promise<any>

المعلمات

icon: string

اسم الرمز

color: string

اللون السداسي المكون من 6 أرقام للأيقونة

v: number

إصدار الرمز (يستخدم فقط لإبطال ذاكرة التخزين المؤقت)

المرتجعات

Promise<any>

getWorkItemIconXaml(string, string, number)

احصل على أيقونة عنصر العمل بإعطاء الاسم المألوف ولون الأيقونة.

function getWorkItemIconXaml(icon: string, color?: string, v?: number): Promise<any>

المعلمات

icon: string

اسم الرمز

color: string

اللون السداسي المكون من 6 أرقام للأيقونة

v: number

إصدار الرمز (يستخدم فقط لإبطال ذاكرة التخزين المؤقت)

المرتجعات

Promise<any>

getWorkItemNextStatesOnCheckinAction(number[], string)

إرجاع الحالة التالية على معرفات عنصر العمل المحددة.

function getWorkItemNextStatesOnCheckinAction(ids: number[], action?: string): Promise<WorkItemNextStateOnTransition[]>

المعلمات

ids: number[]

قائمة معرفات عناصر العمل

action: string

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

المرتجعات

Promise<WorkItemNextStateOnTransition[]>

getWorkItems(number[], string, string[], Date, WorkItemExpand, WorkItemErrorPolicy)

إرجاع قائمة بعناصر العمل (بحد أقصى 200)

function getWorkItems(ids: number[], project?: string, fields?: string[], asOf?: Date, expand?: WorkItemExpand, errorPolicy?: WorkItemErrorPolicy): Promise<WorkItem[]>

المعلمات

ids: number[]

القائمة المفصولة بفواصل لمعرفات عناصر العمل المطلوبة. (الحد الأقصى المسموح به 200 معرف).

project: string

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

fields: string[]

قائمة الحقول المطلوبة مفصولة بفواصل

asOf: Date

سلسلة وقت تاريخ AsOf UTC

expand: WorkItemExpand

معلمات التوسيع لسمات عنصر العمل. الخيارات الممكنة هي { لا شيء ، العلاقات ، الحقول ، الروابط ، الكل }.

errorPolicy: WorkItemErrorPolicy

العلامة للتحكم في نهج الخطأ في طلب الحصول على عناصر العمل المجمعة. الخيارات الممكنة هي {فشل ، حذف}.

المرتجعات

Promise<WorkItem[]>

getWorkItemsBatch(WorkItemBatchGetRequest, string)

الحصول على عناصر العمل لقائمة معرفات عناصر العمل (بحد أقصى 200)

function getWorkItemsBatch(workItemGetRequest: WorkItemBatchGetRequest, project?: string): Promise<WorkItem[]>

المعلمات

workItemGetRequest: WorkItemBatchGetRequest

project: string

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

المرتجعات

Promise<WorkItem[]>

getWorkItemStateColors(string[])

داخلي فقط: سيتم استخدامه لتجربة العمل في حسابي. الحصول على لون حالة نوع عنصر العمل لمشاريع متعددة

function getWorkItemStateColors(projectNames: string[]): Promise<ProjectWorkItemStateColors[]>

المعلمات

projectNames: string[]

المرتجعات

Promise<ProjectWorkItemStateColors[]>

getWorkItemTemplate(string, string, string, Date, WorkItemExpand)

إرجاع عنصر عمل واحد من قالب.

function getWorkItemTemplate(project: string, type: string, fields?: string, asOf?: Date, expand?: WorkItemExpand): Promise<WorkItem>

المعلمات

project: string

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

type: string

اسم نوع عنصر العمل

fields: string

قائمة الحقول المطلوبة مفصولة بفواصل

asOf: Date

سلسلة وقت تاريخ AsOf UTC

expand: WorkItemExpand

معلمات التوسيع لسمات عنصر العمل. الخيارات الممكنة هي { لا شيء ، العلاقات ، الحقول ، الروابط ، الكل }.

المرتجعات

Promise<WorkItem>

getWorkItemType(string, string)

إرجاع تعريف نوع عنصر العمل.

function getWorkItemType(project: string, type: string): Promise<WorkItemType>

المعلمات

project: string

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

type: string

اسم نوع عنصر العمل

المرتجعات

Promise<WorkItemType>

getWorkItemTypeCategories(string)

الحصول على جميع فئات أنواع عناصر العمل.

function getWorkItemTypeCategories(project: string): Promise<WorkItemTypeCategory[]>

المعلمات

project: string

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

المرتجعات

Promise<WorkItemTypeCategory[]>

getWorkItemTypeCategory(string, string)

احصل على فئة نوع عنصر عمل محدد حسب الاسم.

function getWorkItemTypeCategory(project: string, category: string): Promise<WorkItemTypeCategory>

المعلمات

project: string

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

category: string

اسم الفئة

المرتجعات

Promise<WorkItemTypeCategory>

getWorkItemTypeColorAndIcons(string[])

داخلي فقط: يتم استخدامه لموفري الألوان والأيقونات. احصل على لون نوع الذكاء لمشاريع متعددة

function getWorkItemTypeColorAndIcons(projectNames: string[]): Promise<{ key: string, value: WorkItemTypeColorAndIcon[] }[]>

المعلمات

projectNames: string[]

المرتجعات

Promise<{ key: string, value: WorkItemTypeColorAndIcon[] }[]>

getWorkItemTypeColors(string[])

داخلي فقط: سيتم استخدامه لتجربة العمل في حسابي. احصل على لون نوع الذكاء لمشاريع متعددة

function getWorkItemTypeColors(projectNames: string[]): Promise<{ key: string, value: WorkItemTypeColor[] }[]>

المعلمات

projectNames: string[]

المرتجعات

Promise<{ key: string, value: WorkItemTypeColor[] }[]>

getWorkItemTypeFieldsWithReferences(string, string, WorkItemTypeFieldsExpandLevel)

احصل على قائمة بالحقول لنوع عنصر العمل مع مراجع مفصلة.

function getWorkItemTypeFieldsWithReferences(project: string, type: string, expand?: WorkItemTypeFieldsExpandLevel): Promise<WorkItemTypeFieldWithReferences[]>

المعلمات

project: string

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

type: string

نوع عنصر العمل.

expand: WorkItemTypeFieldsExpandLevel

توسيع مستوى استجابة واجهة برمجة التطبيقات. الخصائص: لتضمين القيم المسموح بها ، والقيمة الافتراضية ، وisRequired وما إلى ذلك كجزء من الاستجابة ؛ لا شيء: لتخطي هذه الخصائص.

المرتجعات

Promise<WorkItemTypeFieldWithReferences[]>

getWorkItemTypeFieldWithReferences(string, string, string, WorkItemTypeFieldsExpandLevel)

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

function getWorkItemTypeFieldWithReferences(project: string, type: string, field: string, expand?: WorkItemTypeFieldsExpandLevel): Promise<WorkItemTypeFieldWithReferences>

المعلمات

project: string

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

type: string

نوع عنصر العمل.

field: string

expand: WorkItemTypeFieldsExpandLevel

المرتجعات

Promise<WorkItemTypeFieldWithReferences>

getWorkItemTypes(string)

إرجاع قائمة أنواع عناصر العمل

function getWorkItemTypes(project: string): Promise<WorkItemType[]>

المعلمات

project: string

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

المرتجعات

Promise<WorkItemType[]>

getWorkItemTypeStates(string, string)

إرجاع أسماء الحالات والألوان لنوع عنصر عمل.

function getWorkItemTypeStates(project: string, type: string): Promise<WorkItemStateColor[]>

المعلمات

project: string

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

type: string

اسم الولاية

المرتجعات

Promise<WorkItemStateColor[]>

queryById(string, string, string, boolean, number)

الحصول على نتائج الاستعلام بالنظر إلى معرف الاستعلام.

function queryById(id: string, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<WorkItemQueryResult>

المعلمات

id: string

معرف الاستعلام.

project: string

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

team: string

معرف الفريق أو اسم الفريق

timePrecision: boolean

سواء لاستخدام دقة الوقت أم لا.

top: number

الحد الأقصى لعدد النتائج المراد إرجاعها.

المرتجعات

Promise<WorkItemQueryResult>

queryByWiql(Wiql, string, string, boolean, number)

يحصل على نتائج الاستعلام بالنظر إلى WIQL الخاص به.

function queryByWiql(wiql: Wiql, project?: string, team?: string, timePrecision?: boolean, top?: number): Promise<WorkItemQueryResult>

المعلمات

wiql: Wiql

الاستعلام الذي يحتوي على WIQL.

project: string

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

team: string

معرف الفريق أو اسم الفريق

timePrecision: boolean

سواء لاستخدام دقة الوقت أم لا.

top: number

الحد الأقصى لعدد النتائج المراد إرجاعها.

المرتجعات

Promise<WorkItemQueryResult>

queryWorkItemsForArtifactUris(ArtifactUriQuery, string)

الاستعلامات عن عناصر العمل المرتبطة بقائمة معينة من عنوان URI للعناصر الاصطناعية.

function queryWorkItemsForArtifactUris(artifactUriQuery: ArtifactUriQuery, project?: string): Promise<ArtifactUriQueryResult>

المعلمات

artifactUriQuery: ArtifactUriQuery

يحدد قائمة بعنوان URI للعناصر الاصطناعية للاستعلام عن عناصر العمل.

project: string

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

المرتجعات

Promise<ArtifactUriQueryResult>

readReportingRevisionsGet(string, string[], string[], string, Date, boolean, boolean, boolean, boolean, ReportingRevisionsExpand, boolean, number)

الحصول على مجموعة من مراجعات عناصر العمل مع خيار تضمين العناصر المحذوفة

function readReportingRevisionsGet(project?: string, fields?: string[], types?: string[], continuationToken?: string, startDateTime?: Date, includeIdentityRef?: boolean, includeDeleted?: boolean, includeTagRef?: boolean, includeLatestOnly?: boolean, expand?: ReportingRevisionsExpand, includeDiscussionChangesOnly?: boolean, maxPageSize?: number): Promise<ReportingWorkItemRevisionsBatch>

المعلمات

project: string

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

fields: string[]

قائمة بالحقول التي يجب إرجاعها في مراجعات عناصر العمل. احذف هذه المعلمة للحصول على كافة الحقول القابلة للتقرير.

types: string[]

قائمة بالأنواع لتصفية النتائج إلى أنواع عناصر عمل معينة. حذف هذه المعلمة للحصول على مراجعات عنصر العمل لكافة أنواع عناصر العمل.

continuationToken: string

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

startDateTime: Date

التاريخ/الوقت لاستخدامه كنقطة بداية للمراجعات، ستحدث جميع المراجعات بعد هذا التاريخ/الوقت. لا يمكن استخدامها مع معلمة "العلامة المائية".

includeIdentityRef: boolean

إرجاع مرجع هوية بدلا من قيمة سلسلة لحقول الهوية.

includeDeleted: boolean

حدد ما إذا كان يجب إرجاع العنصر المحذوف.

includeTagRef: boolean

حدد ما إذا كان يجب إرجاع كائنات العلامة لحقل System.Tags.

includeLatestOnly: boolean

إرجاع أحدث المراجعات لعناصر العمل فقط، مع تخطي جميع المراجعات التاريخية

expand: ReportingRevisionsExpand

إرجاع كافة الحقول في مراجعات عنصر العمل، بما في ذلك حقول النص الطويل التي لا يتم إرجاعها بشكل افتراضي

includeDiscussionChangesOnly: boolean

إرجاع فقط تلك المراجعات لعناصر العمل، حيث تم تغيير حقل المحفوظات فقط

maxPageSize: number

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

المرتجعات

Promise<ReportingWorkItemRevisionsBatch>

readReportingRevisionsPost(ReportingWorkItemRevisionsFilter, string, string, Date, ReportingRevisionsExpand)

احصل على مجموعة من مراجعات عناصر العمل. يمكن استخدام هذا الطلب إذا كانت قائمة الحقول كبيرة بما يكفي بحيث يمكنها تشغيل عنوان URL فوق حد الطول.

function readReportingRevisionsPost(filter: ReportingWorkItemRevisionsFilter, project?: string, continuationToken?: string, startDateTime?: Date, expand?: ReportingRevisionsExpand): Promise<ReportingWorkItemRevisionsBatch>

المعلمات

filter: ReportingWorkItemRevisionsFilter

كائن يحتوي على إعدادات الطلب: عامل تصفية الحقل، عامل تصفية النوع، تنسيق الهوية

project: string

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

continuationToken: string

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

startDateTime: Date

expand: ReportingRevisionsExpand

المرتجعات

Promise<ReportingWorkItemRevisionsBatch>

replaceTemplate(WorkItemTemplate, string, string, string)

استبدال محتويات القالب

function replaceTemplate(templateContent: WorkItemTemplate, project: string, team: string, templateId: string): Promise<WorkItemTemplate>

المعلمات

templateContent: WorkItemTemplate

محتويات القالب لاستبدالها

project: string

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

team: string

معرف الفريق أو اسم الفريق

templateId: string

معرف القالب

المرتجعات

Promise<WorkItemTemplate>

restoreWorkItem(WorkItemDeleteUpdate, number, string)

يستعيد عنصر العمل المحذوف من سلة المحذوفات.

function restoreWorkItem(payload: WorkItemDeleteUpdate, id: number, project?: string): Promise<WorkItemDelete>

المعلمات

payload: WorkItemDeleteUpdate

Paylod مع تعليمات لتحديث علامة IsDeleted إلى false

id: number

معرف عنصر العمل المراد استعادته

project: string

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

المرتجعات

Promise<WorkItemDelete>

searchQueries(string, string, number, QueryExpand, boolean)

البحث في جميع طلبات البحث التي يمكن للمستخدم الوصول إليها في المشروع الحالي

function searchQueries(project: string, filter: string, top?: number, expand?: QueryExpand, includeDeleted?: boolean): Promise<QueryHierarchyItemsResult>

المعلمات

project: string

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

filter: string

النص المراد تصفية الاستعلامات به.

top: number

عدد الاستعلامات المطلوب إرجاعها (الافتراضي هو 50 والحد الأقصى هو 200).

expand: QueryExpand

includeDeleted: boolean

تضمين الاستعلامات والمجلدات المحذوفة

المرتجعات

Promise<QueryHierarchyItemsResult>

sendMail(SendMailBody, string)

طريقة RESTful لإرسال البريد لعناصر العمل المحددة / التي تم الاستعلام عنها.

function sendMail(body: SendMailBody, project?: string): Promise<void>

المعلمات

body: SendMailBody

project: string

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

المرتجعات

Promise<void>

updateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

تحديث عقدة تصنيف موجودة.

function updateClassificationNode(postedNode: WorkItemClassificationNode, project: string, structureGroup: TreeStructureGroup, path?: string): Promise<WorkItemClassificationNode>

المعلمات

postedNode: WorkItemClassificationNode

عقدة للإنشاء أو التحديث.

project: string

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

structureGroup: TreeStructureGroup

مجموعة هيكل عقدة التصنيف أو المنطقة أو التكرار.

path: string

مسار عقدة التصنيف.

المرتجعات

Promise<WorkItemClassificationNode>

updateField(UpdateWorkItemField, string, string)

تحديث حقل.

function updateField(payload: UpdateWorkItemField, fieldNameOrRefName: string, project?: string): Promise<WorkItemField>

المعلمات

payload: UpdateWorkItemField

تحتوي الحمولة على القيمة المطلوبة لخصائص الحقل

fieldNameOrRefName: string

الاسم/الاسم المرجعي للحقل المراد تحديثه

project: string

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

المرتجعات

Promise<WorkItemField>

updateQuery(QueryHierarchyItem, string, string, boolean)

تحديث استعلام أو مجلد. يتيح لك ذلك تحديث الاستعلامات والمجلدات وإعادة تسميتها ونقلها.

function updateQuery(queryUpdate: QueryHierarchyItem, project: string, query: string, undeleteDescendants?: boolean): Promise<QueryHierarchyItem>

المعلمات

queryUpdate: QueryHierarchyItem

الاستعلام المطلوب تحديثه.

project: string

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

query: string

المعرف أو المسار لتحديث الاستعلام.

undeleteDescendants: boolean

قم بإلغاء حذف العناصر الفرعية لهذا المجلد. من المهم ملاحظة أن هذا لن يعيد تغييرات الأذونات التي تم تطبيقها مسبقا على الأحفاد.

المرتجعات

Promise<QueryHierarchyItem>

updateWorkItem(JsonPatchDocument, number, string, boolean, boolean, boolean, WorkItemExpand)

تحديث عنصر عمل واحد.

function updateWorkItem(document: JsonPatchDocument, id: number, project?: string, validateOnly?: boolean, bypassRules?: boolean, suppressNotifications?: boolean, expand?: WorkItemExpand): Promise<WorkItem>

المعلمات

document: JsonPatchDocument

مستند تصحيح JSON الذي يمثل التحديث

id: number

معرف عنصر العمل المراد تحديثه

project: string

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

validateOnly: boolean

حدد ما إذا كنت تريد التحقق من صحة التغييرات فقط دون حفظ عنصر العمل

bypassRules: boolean

لا تفرض قواعد نوع عنصر العمل على هذا التحديث

suppressNotifications: boolean

لا تقم بإطلاق أي إشعارات لهذا التغيير

expand: WorkItemExpand

معلمات التوسيع لسمات عنصر العمل. الخيارات الممكنة هي { لا شيء ، العلاقات ، الحقول ، الروابط ، الكل }.

المرتجعات

Promise<WorkItem>

updateWorkItemTypeDefinition(WorkItemTypeTemplateUpdateModel, string)

إضافة/تحديث نوع عنصر عمل

function updateWorkItemTypeDefinition(updateModel: WorkItemTypeTemplateUpdateModel, project?: string): Promise<ProvisioningResult>

المعلمات

updateModel: WorkItemTypeTemplateUpdateModel

project: string

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

المرتجعات

Promise<ProvisioningResult>

الملاحظات

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

مشاركة عبر

WorkItemTrackingRestClient class

المنشئون

الخصائص

الأساليب

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

WorkItemTrackingRestClient(IVssRestClientOptions)

المعلمات

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

RESOURCE_AREA_ID

قيمة الخاصية

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

createAttachment(any, string, string, string, string)

المعلمات

المرتجعات

createField(WorkItemField, string)

المعلمات

المرتجعات

createOrUpdateClassificationNode(WorkItemClassificationNode, string, TreeStructureGroup, string)

المعلمات

المرتجعات

createQuery(QueryHierarchyItem, string, string, boolean)

المعلمات

المرتجعات

createTemplate(WorkItemTemplate, string, string)

المعلمات

المرتجعات

createWorkItem(JsonPatchDocument, string, string, boolean, boolean, boolean, WorkItemExpand)

المعلمات

المرتجعات

deleteClassificationNode(string, TreeStructureGroup, string, number)

المعلمات

المرتجعات

deleteField(string, string)

المعلمات

المرتجعات

deleteQuery(string, string)

المعلمات

المرتجعات

deleteTemplate(string, string, string)

المعلمات

المرتجعات

deleteWorkItem(number, string, boolean)

المعلمات

المرتجعات

destroyWorkItem(number, string)

المعلمات

المرتجعات

exportWorkItemTypeDefinition(string, string, boolean)

المعلمات

المرتجعات

getAccountMyWorkData(QueryOption)

المعلمات

المرتجعات

getAttachmentContent(string, string, string, boolean)

المعلمات

المرتجعات

getAttachmentZip(string, string, string, boolean)

المعلمات

المرتجعات

getClassificationNode(string, TreeStructureGroup, string, number)

المعلمات

المرتجعات

getClassificationNodes(string, number[], number, ClassificationNodesErrorPolicy)

المعلمات

المرتجعات

getComment(number, number, string)

المعلمات

المرتجعات

getComments(number, string, number, number, CommentSortOrder)

المعلمات

المرتجعات

getDeletedWorkItem(number, string)

المعلمات

المرتجعات

getDeletedWorkItems(number[], string)

المعلمات

المرتجعات

getDeletedWorkItemShallowReferences(string)

المعلمات