TestRestClient class
الفئة الأساسية التي يجب استخدامها (مشتقة من) لتقديم طلبات إلى VSS REST apis
- يمتد
الخصائص
| RESOURCE_AREA_ID |
الأساليب
تفاصيل المنشئ
TestRestClient(IVssRestClientOptions)
تفاصيل الخاصية
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: string
قيمة الخاصية
string
تفاصيل الأسلوب
addCustomFields(CustomTestFieldDefinition[], string)
function addCustomFields(newFields: CustomTestFieldDefinition[], project: string): Promise<CustomTestFieldDefinition[]>
المعلمات
- newFields
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<CustomTestFieldDefinition[]>
addTestCasesToSuite(string, number, number, string)
أضف حالات الاختبار إلى المجموعة.
function addTestCasesToSuite(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<SuiteTestCase[]>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- planId
-
number
معرف خطة الاختبار التي تحتوي على المجموعة.
- suiteId
-
number
معرف مجموعة الاختبار التي يجب إضافة حالات الاختبار إليها.
- testCaseIds
-
string
معرفات حالات الاختبار لإضافتها إلى المجموعة. يتم تحديد المعرف بتنسيق مفصول بفواصل.
المرتجعات
Promise<SuiteTestCase[]>
addTestResultsToTestRun(TestCaseResult[], string, number)
إضافة نتائج الاختبار إلى اختبار التشغيل.
function addTestResultsToTestRun(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>
المعلمات
- results
قائمة بنتائج الاختبار المراد إضافتها.
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
اختبار معرف التشغيل الذي يجب إضافة نتائج الاختبار إليه.
المرتجعات
Promise<TestCaseResult[]>
addWorkItemToTestLinks(WorkItemToTestLinks, string)
function addWorkItemToTestLinks(workItemToTestLinks: WorkItemToTestLinks, project: string): Promise<WorkItemToTestLinks>
المعلمات
- workItemToTestLinks
- WorkItemToTestLinks
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<WorkItemToTestLinks>
createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)
إرفاق ملف لاختبار نتيجة الخطوة
function createTestIterationResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number, iterationId: number, actionPath?: string): Promise<TestAttachmentReference>
المعلمات
- attachmentRequestModel
- TestAttachmentRequestModel
تفاصيل المرفق TestAttachmentRequestModel
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
معرف تشغيل الاختبار الذي يحتوي على النتيجة.
- testCaseResultId
-
number
معرف نتيجة الاختبار التي تحتوي على التكرار
- iterationId
-
number
معرف تكرار نتيجة الاختبار.
- actionPath
-
string
قيمة سداسية لمسار إجراء نتيجة الاختبار.
المرتجعات
Promise<TestAttachmentReference>
createTestResultAttachment(TestAttachmentRequestModel, string, number, number)
إرفاق ملف بنتيجة اختبار.
function createTestResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number): Promise<TestAttachmentReference>
المعلمات
- attachmentRequestModel
- TestAttachmentRequestModel
تفاصيل المرفق TestAttachmentRequestModel
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
معرف تشغيل الاختبار الذي يحتوي على النتيجة.
- testCaseResultId
-
number
معرف نتيجة الاختبار التي يجب تحميل المرفق عليها.
المرتجعات
Promise<TestAttachmentReference>
createTestRun(RunCreateModel, string)
إنشاء تشغيل اختبار جديد.
function createTestRun(testRun: RunCreateModel, project: string): Promise<TestRun>
المعلمات
- testRun
- RunCreateModel
تفاصيل التشغيل RunCreateModel
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<TestRun>
createTestRunAttachment(TestAttachmentRequestModel, string, number)
إرفاق ملف بتشغيل اختبار.
function createTestRunAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number): Promise<TestAttachmentReference>
المعلمات
- attachmentRequestModel
- TestAttachmentRequestModel
تفاصيل المرفق TestAttachmentRequestModel
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
يتم تشغيل معرف الاختبار الذي يجب تحميل المرفق عليه.
المرتجعات
Promise<TestAttachmentReference>
createTestSession(TestSession, TeamContext)
إنشاء جلسة اختبار
function createTestSession(testSession: TestSession, teamContext: TeamContext): Promise<TestSession>
المعلمات
- testSession
- TestSession
اختبار تفاصيل جلسة العمل للإنشاء
- teamContext
- TeamContext
سياق الفريق للعملية
المرتجعات
Promise<TestSession>
createTestSettings(TestSettings, string)
function createTestSettings(testSettings: TestSettings, project: string): Promise<number>
المعلمات
- testSettings
- TestSettings
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<number>
createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)
إرفاق ملف بنتيجة اختبار
function createTestSubResultAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachmentReference>
المعلمات
- attachmentRequestModel
- TestAttachmentRequestModel
نموذج طلب المرفقات.
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
معرف تشغيل الاختبار الذي يحتوي على النتيجة.
- testCaseResultId
-
number
معرف نتائج الاختبار التي تحتوي على نتيجة فرعية.
- testSubResultId
-
number
معرف نتائج الاختبار الفرعية التي يجب تحميل المرفق عليها.
المرتجعات
Promise<TestAttachmentReference>
deleteSharedParameter(string, number)
function deleteSharedParameter(project: string, sharedParameterId: number): Promise<void>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- sharedParameterId
-
number
المرتجعات
Promise<void>
deleteSharedStep(string, number)
function deleteSharedStep(project: string, sharedStepId: number): Promise<void>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- sharedStepId
-
number
المرتجعات
Promise<void>
deleteTestCase(string, number)
حذف حالة اختبار.
function deleteTestCase(project: string, testCaseId: number): Promise<void>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- testCaseId
-
number
معرف حالة الاختبار المراد حذفها.
المرتجعات
Promise<void>
deleteTestMethodToWorkItemLink(string, string, number)
function deleteTestMethodToWorkItemLink(project: string, testName: string, workItemId: number): Promise<boolean>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- testName
-
string
- workItemId
-
number
المرتجعات
Promise<boolean>
deleteTestRun(string, number)
حذف اختبار يتم تشغيله بواسطة معرفه.
function deleteTestRun(project: string, runId: number): Promise<void>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
معرف التشغيل المراد حذفه.
المرتجعات
Promise<void>
deleteTestSettings(string, number)
function deleteTestSettings(project: string, testSettingsId: number): Promise<void>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- testSettingsId
-
number
المرتجعات
Promise<void>
getBugsLinkedToTestResult(string, number, number)
function getBugsLinkedToTestResult(project: string, runId: number, testCaseResultId: number): Promise<WorkItemReference[]>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
- testCaseResultId
-
number
المرتجعات
Promise<WorkItemReference[]>
getBuildCodeCoverage(string, number, number)
احصل على بيانات تغطية التعليمات البرمجية للبنية.
function getBuildCodeCoverage(project: string, buildId: number, flags: number): Promise<BuildCoverage[]>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- buildId
-
number
معرف البنية التي يجب إحضار بيانات تغطية التعليمات البرمجية لها.
- flags
-
number
تحدد قيمة العلامات مستوى تفاصيل تغطية التعليمات البرمجية التي سيتم جلبها. العلامات مضافة. القيم المتوقعة هي 1 للوحدات النمطية، و2 للدالات، و4 ل BlockData.
المرتجعات
Promise<BuildCoverage[]>
getCodeCoverageSummary(string, number, number)
الحصول على ملخص تغطية التعليمات البرمجية للبناء.
function getCodeCoverageSummary(project: string, buildId: number, deltaBuildId?: number): Promise<CodeCoverageSummary>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- buildId
-
number
معرف البنية التي يجب إحضار بيانات تغطية التعليمات البرمجية لها.
- deltaBuildId
-
number
معرف بناء دلتا (اختياري)
المرتجعات
Promise<CodeCoverageSummary>
getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)
function getLinkedWorkItemsByQuery(workItemQuery: LinkedWorkItemsQuery, project: string): Promise<LinkedWorkItemsQueryResult[]>
المعلمات
- workItemQuery
- LinkedWorkItemsQuery
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<LinkedWorkItemsQueryResult[]>
getPoint(string, number, number, number, string)
احصل على نقطة اختبار.
function getPoint(project: string, planId: number, suiteId: number, pointIds: number, witFields?: string): Promise<TestPoint>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- planId
-
number
معرف خطة الاختبار.
- suiteId
-
number
معرف المجموعة الذي يحتوي على النقطة .
- pointIds
-
number
معرف نقطة الاختبار التي يجب الحصول عليها.
- witFields
-
string
قائمة مفصولة بفواصل بأسماء حقول عناصر العمل.
المرتجعات
Promise<TestPoint>
getPoints(string, number, number, string, string, string, string, boolean, number, number)
احصل على قائمة بنقاط الاختبار.
function getPoints(project: string, planId: number, suiteId: number, witFields?: string, configurationId?: string, testCaseId?: string, testPointIds?: string, includePointDetails?: boolean, skip?: number, top?: number): Promise<TestPoint[]>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- planId
-
number
معرف خطة الاختبار.
- suiteId
-
number
معرف المجموعة الذي يحتوي على النقاط.
- witFields
-
string
قائمة مفصولة بفواصل بأسماء حقول عناصر العمل.
- configurationId
-
string
احصل على نقاط اختبار لتكوين معين.
- testCaseId
-
string
احصل على نقاط اختبار لحالة اختبار معينة، صالحة عند عدم تعيين configurationId.
- testPointIds
-
string
احصل على نقاط اختبار لقائمة مفصولة بفاصلة من معرفات نقاط الاختبار، صالحة فقط عند عدم تعيين configurationId وtestCaseId.
- includePointDetails
-
boolean
قم بتضمين كافة خصائص نقطة الاختبار.
- skip
-
number
عدد نقاط الاختبار التي يجب تخطيها.
- top
-
number
عدد نقاط الاختبار التي يجب إرجاعها.
المرتجعات
Promise<TestPoint[]>
getPointsByQuery(TestPointsQuery, string, number, number)
الحصول على نقاط الاختبار باستخدام الاستعلام.
function getPointsByQuery(query: TestPointsQuery, project: string, skip?: number, top?: number): Promise<TestPointsQuery>
المعلمات
- query
- TestPointsQuery
TestPointsQuery للحصول على نقاط الاختبار.
- project
-
string
معرف المشروع أو اسم المشروع
- skip
-
number
عدد نقاط الاختبار التي يجب تخطيها.
- top
-
number
عدد نقاط الاختبار التي يجب إرجاعها.
المرتجعات
Promise<TestPointsQuery>
getResultGroupsByBuild(string, number, string, string[], string)
function getResultGroupsByBuild(project: string, buildId: number, publishContext: string, fields?: string[], continuationToken?: string): Promise<PagedList<FieldDetailsForTestResults>>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- buildId
-
number
- publishContext
-
string
- fields
-
string[]
- continuationToken
-
string
المرتجعات
Promise<PagedList<FieldDetailsForTestResults>>
getResultGroupsByRelease(string, number, string, number, string[], string)
function getResultGroupsByRelease(project: string, releaseId: number, publishContext: string, releaseEnvId?: number, fields?: string[], continuationToken?: string): Promise<PagedList<FieldDetailsForTestResults>>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- releaseId
-
number
- publishContext
-
string
- releaseEnvId
-
number
- fields
-
string[]
- continuationToken
-
string
المرتجعات
Promise<PagedList<FieldDetailsForTestResults>>
getResultRetentionSettings(string)
الحصول على إعدادات استبقاء نتائج الاختبار
function getResultRetentionSettings(project: string): Promise<ResultRetentionSettings>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<ResultRetentionSettings>
getTestCaseById(string, number, number, number)
احصل على حالة اختبار محددة في مجموعة اختبار مع معرف حالة الاختبار.
function getTestCaseById(project: string, planId: number, suiteId: number, testCaseIds: number): Promise<SuiteTestCase>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- planId
-
number
معرف خطة الاختبار التي تحتوي على المجموعات.
- suiteId
-
number
معرف المجموعة الذي يحتوي على حالة الاختبار.
- testCaseIds
-
number
معرف حالة الاختبار التي يجب الحصول عليها.
المرتجعات
Promise<SuiteTestCase>
getTestCases(string, number, number)
احصل على جميع حالات الاختبار في مجموعة.
function getTestCases(project: string, planId: number, suiteId: number): Promise<SuiteTestCase[]>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- planId
-
number
معرف خطة الاختبار التي تحتوي على المجموعات.
- suiteId
-
number
معرف الجناح الذي يجب الحصول عليه.
المرتجعات
Promise<SuiteTestCase[]>
getTestIteration(string, number, number, number, boolean)
الحصول على التكرار للحصول على نتيجة
function getTestIteration(project: string, runId: number, testCaseResultId: number, iterationId: number, includeActionResults?: boolean): Promise<TestIterationDetailsModel>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
معرف تشغيل الاختبار الذي يحتوي على النتيجة.
- testCaseResultId
-
number
معرف نتيجة الاختبار التي تحتوي على التكرارات.
- iterationId
-
number
معرف تكرار نتائج الاختبار.
- includeActionResults
-
boolean
قم بتضمين تفاصيل النتائج لكل إجراء يتم تنفيذه في تكرار الاختبار. تشير ActionResults إلى نتيجة (نجاح/فشل) خطوات الاختبار التي يتم تنفيذها كجزء من تشغيل اختبار يدوي. بما في ذلك علامة ActionResults تحصل على نتيجة خطوات الاختبار في قسم actionResults ومعلمات الاختبار في قسم المعلمات لكل تكرار اختبار.
المرتجعات
Promise<TestIterationDetailsModel>
getTestIterations(string, number, number, boolean)
الحصول على التكرارات للحصول على نتيجة
function getTestIterations(project: string, runId: number, testCaseResultId: number, includeActionResults?: boolean): Promise<TestIterationDetailsModel[]>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
معرف تشغيل الاختبار الذي يحتوي على النتيجة.
- testCaseResultId
-
number
معرف نتيجة الاختبار التي تحتوي على التكرارات.
- includeActionResults
-
boolean
قم بتضمين تفاصيل النتائج لكل إجراء يتم تنفيذه في تكرار الاختبار. تشير ActionResults إلى نتيجة (نجاح/فشل) خطوات الاختبار التي يتم تنفيذها كجزء من تشغيل اختبار يدوي. بما في ذلك علامة ActionResults تحصل على نتيجة خطوات الاختبار في قسم actionResults ومعلمات الاختبار في قسم المعلمات لكل تكرار اختبار.
المرتجعات
Promise<TestIterationDetailsModel[]>
getTestResultAttachmentContent(string, number, number, number)
قم بتنزيل مرفق نتيجة الاختبار بواسطة معرفه.
function getTestResultAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<ArrayBuffer>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
معرف تشغيل الاختبار الذي يحتوي على testCaseResultId.
- testCaseResultId
-
number
معرف نتيجة الاختبار التي يجب تنزيل مرفقها.
- attachmentId
-
number
معرف مرفق نتيجة الاختبار المراد تنزيله.
المرتجعات
Promise<ArrayBuffer>
getTestResultAttachments(string, number, number)
الحصول على قائمة بمرجع مرفقات نتائج الاختبار.
function getTestResultAttachments(project: string, runId: number, testCaseResultId: number): Promise<TestAttachment[]>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
معرف تشغيل الاختبار الذي يحتوي على النتيجة.
- testCaseResultId
-
number
معرف نتيجة الاختبار.
المرتجعات
Promise<TestAttachment[]>
getTestResultAttachmentZip(string, number, number, number)
قم بتنزيل مرفق نتيجة الاختبار بواسطة معرفه.
function getTestResultAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<ArrayBuffer>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
معرف تشغيل الاختبار الذي يحتوي على testCaseResultId.
- testCaseResultId
-
number
معرف نتيجة الاختبار التي يجب تنزيل مرفقها.
- attachmentId
-
number
معرف مرفق نتيجة الاختبار المراد تنزيله.
المرتجعات
Promise<ArrayBuffer>
getTestResultById(string, number, number, ResultDetails)
الحصول على نتيجة اختبار لتشغيل اختبار.
function getTestResultById(project: string, runId: number, testCaseResultId: number, detailsToInclude?: ResultDetails): Promise<TestCaseResult>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
اختبار معرف التشغيل لنتيجة اختبار لجلبها.
- testCaseResultId
-
number
معرف نتيجة الاختبار.
- detailsToInclude
- ResultDetails
التفاصيل التي يجب تضمينها مع نتائج الاختبار. الافتراضي هو بلا. القيم الأخرى هي التكرارات و WorkItems و SubResults.
المرتجعات
Promise<TestCaseResult>
getTestResultDetailsForBuild(string, number, string, string, string, string, boolean, boolean)
function getTestResultDetailsForBuild(project: string, buildId: number, publishContext?: string, groupBy?: string, filter?: string, orderby?: string, shouldIncludeResults?: boolean, queryRunSummaryForInProgress?: boolean): Promise<TestResultsDetails>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- buildId
-
number
- publishContext
-
string
- groupBy
-
string
- filter
-
string
- orderby
-
string
- shouldIncludeResults
-
boolean
- queryRunSummaryForInProgress
-
boolean
المرتجعات
Promise<TestResultsDetails>
getTestResultDetailsForRelease(string, number, number, string, string, string, string, boolean, boolean)
function getTestResultDetailsForRelease(project: string, releaseId: number, releaseEnvId: number, publishContext?: string, groupBy?: string, filter?: string, orderby?: string, shouldIncludeResults?: boolean, queryRunSummaryForInProgress?: boolean): Promise<TestResultsDetails>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- releaseId
-
number
- releaseEnvId
-
number
- publishContext
-
string
- groupBy
-
string
- filter
-
string
- orderby
-
string
- shouldIncludeResults
-
boolean
- queryRunSummaryForInProgress
-
boolean
المرتجعات
Promise<TestResultsDetails>
getTestResults(string, number, ResultDetails, number, number, TestOutcome[])
الحصول على نتائج الاختبار لتشغيل اختبار.
function getTestResults(project: string, runId: number, detailsToInclude?: ResultDetails, skip?: number, top?: number, outcomes?: TestOutcome[]): Promise<TestCaseResult[]>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
اختبار معرف تشغيل نتائج الاختبار لجلبها.
- detailsToInclude
- ResultDetails
التفاصيل التي يجب تضمينها مع نتائج الاختبار. الافتراضي هو بلا. القيم الأخرى هي التكرارات و WorkItems.
- skip
-
number
عدد نتائج الاختبار التي يجب تخطيها من البداية.
- top
-
number
عدد نتائج الاختبار التي سيتم إرجاعها. الحد الأقصى هو 1000 عندما تكون detailsToInclude هي None و200 بخلاف ذلك.
- outcomes
قائمة مفصولة بفواصل لنتائج الاختبار لتصفية نتائج الاختبار.
المرتجعات
Promise<TestCaseResult[]>
getTestResultsByBuild(string, number, string, TestOutcome[], number, string)
function getTestResultsByBuild(project: string, buildId: number, publishContext?: string, outcomes?: TestOutcome[], top?: number, continuationToken?: string): Promise<PagedList<ShallowTestCaseResult>>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- buildId
-
number
- publishContext
-
string
- outcomes
- top
-
number
- continuationToken
-
string
المرتجعات
Promise<PagedList<ShallowTestCaseResult>>
getTestResultsByQuery(TestResultsQuery, string)
سترجع واجهة برمجة التطبيقات هذه النتائج حسب المعرف مع الحقول المحددة/الاتجاه لأسلوب اختبار تلقائي معين. ما زلنا نعمل على تحسين واجهة برمجة التطبيقات هذه ولم ننهي التوقيع والتعاقد المناسبين.
function getTestResultsByQuery(query: TestResultsQuery, project: string): Promise<TestResultsQuery>
المعلمات
- query
- TestResultsQuery
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<TestResultsQuery>
getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)
function getTestResultsByRelease(project: string, releaseId: number, releaseEnvid?: number, publishContext?: string, outcomes?: TestOutcome[], top?: number, continuationToken?: string): Promise<PagedList<ShallowTestCaseResult>>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- releaseId
-
number
- releaseEnvid
-
number
- publishContext
-
string
- outcomes
- top
-
number
- continuationToken
-
string
المرتجعات
Promise<PagedList<ShallowTestCaseResult>>
getTestRunAttachmentContent(string, number, number)
قم بتنزيل مرفق تشغيل اختبار بواسطة معرفه.
function getTestRunAttachmentContent(project: string, runId: number, attachmentId: number): Promise<ArrayBuffer>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
معرف تشغيل الاختبار الذي يجب تنزيل مرفقه.
- attachmentId
-
number
معرف مرفق تشغيل الاختبار المراد تنزيله.
المرتجعات
Promise<ArrayBuffer>
getTestRunAttachments(string, number)
الحصول على قائمة اختبار مرجع مرفقات التشغيل.
function getTestRunAttachments(project: string, runId: number): Promise<TestAttachment[]>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
معرف تشغيل الاختبار.
المرتجعات
Promise<TestAttachment[]>
getTestRunAttachmentZip(string, number, number)
قم بتنزيل مرفق تشغيل اختبار بواسطة معرفه.
function getTestRunAttachmentZip(project: string, runId: number, attachmentId: number): Promise<ArrayBuffer>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
معرف تشغيل الاختبار الذي يجب تنزيل مرفقه.
- attachmentId
-
number
معرف مرفق تشغيل الاختبار المراد تنزيله.
المرتجعات
Promise<ArrayBuffer>
getTestRunById(string, number, boolean)
احصل على اختبار يتم تشغيله بواسطة معرفه.
function getTestRunById(project: string, runId: number, includeDetails?: boolean): Promise<TestRun>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
معرف التشغيل للحصول عليه.
- includeDetails
-
boolean
القيمة الافتراضية صحيحة. يتضمن تفاصيل مثل إحصائيات التشغيل والإصدار والبناء وبيئة الاختبار وحالة ما بعد العملية والمزيد.
المرتجعات
Promise<TestRun>
getTestRunCodeCoverage(string, number, number)
الحصول على بيانات تغطية التعليمات البرمجية لتشغيل اختبار
function getTestRunCodeCoverage(project: string, runId: number, flags: number): Promise<TestRunCoverage[]>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
معرف تشغيل الاختبار الذي يجب إحضار بيانات تغطية التعليمات البرمجية له.
- flags
-
number
تحدد قيمة العلامات مستوى تفاصيل تغطية التعليمات البرمجية التي سيتم جلبها. العلامات مضافة. القيم المتوقعة هي 1 للوحدات النمطية، و2 للدالات، و4 ل BlockData.
المرتجعات
Promise<TestRunCoverage[]>
getTestRunLogs(string, number)
الحصول على سجلات رسائل تشغيل الاختبار
function getTestRunLogs(project: string, runId: number): Promise<TestMessageLogDetails[]>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
معرف التشغيل للحصول عليه.
المرتجعات
Promise<TestMessageLogDetails[]>
getTestRuns(string, string, string, string, number, boolean, boolean, number, number)
احصل على قائمة بتشغيلات الاختبار.
function getTestRuns(project: string, buildUri?: string, owner?: string, tmiRunId?: string, planId?: number, includeRunDetails?: boolean, automated?: boolean, skip?: number, top?: number): Promise<TestRun[]>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- buildUri
-
string
URI للبنية التي تستخدمها عمليات التشغيل.
- owner
-
string
معرف أساس الفريق لمالك عمليات التشغيل.
- tmiRunId
-
string
- planId
-
number
معرف خطة الاختبار التي تعد عمليات التشغيل جزءا منها.
- includeRunDetails
-
boolean
إذا كان صحيحا، فضمن كافة خصائص عمليات التشغيل.
- automated
-
boolean
إذا كان صحيحا، فترجع عمليات التشغيل التلقائية فقط.
- skip
-
number
عدد عمليات تشغيل الاختبار التي يجب تخطيها.
- top
-
number
عدد عمليات تشغيل الاختبار التي يجب إرجاعها.
المرتجعات
Promise<TestRun[]>
getTestRunStatistics(string, number)
احصل على إحصائيات تشغيل الاختبار ، وتستخدم عندما نريد الحصول على ملخص للتشغيل حسب النتيجة.
function getTestRunStatistics(project: string, runId: number): Promise<TestRunStatistic>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
معرف التشغيل للحصول عليه.
المرتجعات
Promise<TestRunStatistic>
getTestSessions(TeamContext, number, boolean, boolean, TestSessionSource, boolean)
الحصول على قائمة بجلسات الاختبار
function getTestSessions(teamContext: TeamContext, period?: number, allSessions?: boolean, includeAllProperties?: boolean, source?: TestSessionSource, includeOnlyCompletedSessions?: boolean): Promise<TestSession[]>
المعلمات
- teamContext
- TeamContext
سياق الفريق للعملية
- period
-
number
الفترة بالأيام من الآن، والتي يتم إحضار جلسات الاختبار لها.
- allSessions
-
boolean
إذا كانت خاطئة، فترجع جلسات الاختبار للمستخدم الحالي. وإلا، فإنه يرجع جلسات الاختبار لجميع المستخدمين
- includeAllProperties
-
boolean
إذا كان صحيحا، فإنه يرجع كافة خصائص جلسات الاختبار. وإلا، فإنه يرجع الإصدار النحيل.
- source
- TestSessionSource
مصدر جلسة الاختبار.
- includeOnlyCompletedSessions
-
boolean
إذا كان صحيحا، فإنه يرجع جلسات الاختبار في حالة مكتملة. وإلا، فإنه يقوم بإرجاع جلسات الاختبار لجميع الحالات
المرتجعات
Promise<TestSession[]>
getTestSettingsById(string, number)
function getTestSettingsById(project: string, testSettingsId: number): Promise<TestSettings>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- testSettingsId
-
number
المرتجعات
Promise<TestSettings>
getTestSubResultAttachmentContent(string, number, number, number, number)
تنزيل مرفق نتيجة فرعية للاختبار
function getTestSubResultAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number, testSubResultId: number): Promise<ArrayBuffer>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
معرف تشغيل الاختبار الذي يحتوي على النتيجة.
- testCaseResultId
-
number
معرف نتائج الاختبار التي تحتوي على نتيجة فرعية.
- attachmentId
-
number
معرف مرفق نتيجة الاختبار المراد تنزيله
- testSubResultId
-
number
معرف نتيجة الاختبار الفرعية التي يجب تنزيل مرفقها
المرتجعات
Promise<ArrayBuffer>
getTestSubResultAttachments(string, number, number, number)
الحصول على قائمة بمرفقات النتائج الفرعية للاختبار
function getTestSubResultAttachments(project: string, runId: number, testCaseResultId: number, testSubResultId: number): Promise<TestAttachment[]>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
معرف تشغيل الاختبار الذي يحتوي على النتيجة.
- testCaseResultId
-
number
معرف نتائج الاختبار التي تحتوي على نتيجة فرعية.
- testSubResultId
-
number
معرف نتيجة الاختبار الفرعية التي يجب تنزيل مرفقها
المرتجعات
Promise<TestAttachment[]>
getTestSubResultAttachmentZip(string, number, number, number, number)
تنزيل مرفق نتيجة فرعية للاختبار
function getTestSubResultAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number, testSubResultId: number): Promise<ArrayBuffer>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
معرف تشغيل الاختبار الذي يحتوي على النتيجة.
- testCaseResultId
-
number
معرف نتائج الاختبار التي تحتوي على نتيجة فرعية.
- attachmentId
-
number
معرف مرفق نتيجة الاختبار المراد تنزيله
- testSubResultId
-
number
معرف نتيجة الاختبار الفرعية التي يجب تنزيل مرفقها
المرتجعات
Promise<ArrayBuffer>
processSuitesForStaging(StagedSuitesRequestModel, string, number)
يعالج مجموعة من مجموعات الاختبار ويرجع نموذج استجابة يحتوي على تفاصيل المجموعة وحالة الاختبار.
function processSuitesForStaging(request: StagedSuitesRequestModel, project: string, workItemId: number): Promise<StagedSuitesResponseModel>
المعلمات
- request
- StagedSuitesRequestModel
نموذج الطلب الذي يحتوي على مجموعات الاختبار المراد معالجتها. لا يمكن أن تكون فارغة.
- project
-
string
معرف المشروع أو اسم المشروع
- workItemId
-
number
المرتجعات
Promise<StagedSuitesResponseModel>
publishTestResultDocument(TestResultDocument, string, number)
function publishTestResultDocument(document: TestResultDocument, project: string, runId: number): Promise<TestResultDocument>
المعلمات
- document
- TestResultDocument
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
المرتجعات
Promise<TestResultDocument>
queryCustomFields(string, CustomTestFieldScope)
function queryCustomFields(project: string, scopeFilter: CustomTestFieldScope): Promise<CustomTestFieldDefinition[]>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- scopeFilter
- CustomTestFieldScope
المرتجعات
Promise<CustomTestFieldDefinition[]>
queryResultTrendForBuild(TestResultTrendFilter, string)
function queryResultTrendForBuild(filter: TestResultTrendFilter, project: string): Promise<AggregatedDataForResultTrend[]>
المعلمات
- filter
- TestResultTrendFilter
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<AggregatedDataForResultTrend[]>
queryResultTrendForRelease(TestResultTrendFilter, string)
function queryResultTrendForRelease(filter: TestResultTrendFilter, project: string): Promise<AggregatedDataForResultTrend[]>
المعلمات
- filter
- TestResultTrendFilter
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<AggregatedDataForResultTrend[]>
queryTestHistory(TestHistoryQuery, string)
الحصول على محفوظات أسلوب اختبار باستخدام TestHistoryQuery
function queryTestHistory(filter: TestHistoryQuery, project: string): Promise<TestHistoryQuery>
المعلمات
- filter
- TestHistoryQuery
TestHistoryQuery للحصول على المحفوظات
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<TestHistoryQuery>
queryTestMethodLinkedWorkItems(string, string)
function queryTestMethodLinkedWorkItems(project: string, testName: string): Promise<TestToWorkItemLinks>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- testName
-
string
المرتجعات
Promise<TestToWorkItemLinks>
queryTestResultHistory(ResultsFilter, string)
function queryTestResultHistory(filter: ResultsFilter, project: string): Promise<TestResultHistory>
المعلمات
- filter
- ResultsFilter
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<TestResultHistory>
queryTestResultsMetaData(string[], string)
الحصول على قائمة بتفاصيل بيانات تعريف نتيجة الاختبار ل testcasereferenceId المقابل
function queryTestResultsMetaData(testReferenceIds: string[], project: string): Promise<TestResultMetaData[]>
المعلمات
- testReferenceIds
-
string[]
معرفات TestCaseReference الخاصة بنتيجة الاختبار التي سيتم الاستعلام عنها، قائمة مفصولة بفواصل من المعرفات الصالحة (الحد رقم المعرف 200).
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<TestResultMetaData[]>
queryTestResultsReportForBuild(string, number, string, boolean, BuildReference)
function queryTestResultsReportForBuild(project: string, buildId: number, publishContext?: string, includeFailureDetails?: boolean, buildToCompare?: BuildReference): Promise<TestResultSummary>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- buildId
-
number
- publishContext
-
string
- includeFailureDetails
-
boolean
- buildToCompare
- BuildReference
المرتجعات
Promise<TestResultSummary>
queryTestResultsReportForRelease(string, number, number, string, boolean, ReleaseReference)
function queryTestResultsReportForRelease(project: string, releaseId: number, releaseEnvId: number, publishContext?: string, includeFailureDetails?: boolean, releaseToCompare?: ReleaseReference): Promise<TestResultSummary>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- releaseId
-
number
- releaseEnvId
-
number
- publishContext
-
string
- includeFailureDetails
-
boolean
- releaseToCompare
- ReleaseReference
المرتجعات
Promise<TestResultSummary>
queryTestResultsSummaryForReleases(ReleaseReference[], string)
function queryTestResultsSummaryForReleases(releases: ReleaseReference[], project: string): Promise<TestResultSummary[]>
المعلمات
- releases
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<TestResultSummary[]>
queryTestResultWorkItems(string, string, string, number, Date, number, number)
function queryTestResultWorkItems(project: string, workItemCategory: string, automatedTestName?: string, testCaseId?: number, maxCompleteDate?: Date, days?: number, workItemCount?: number): Promise<WorkItemReference[]>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- workItemCategory
-
string
- automatedTestName
-
string
- testCaseId
-
number
- maxCompleteDate
-
Date
- days
-
number
- workItemCount
-
number
المرتجعات
Promise<WorkItemReference[]>
queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, string)
تشغيل اختبار الاستعلام استنادا إلى عوامل التصفية. الحقول الإلزامية هي minLastUpdatedDate وmaxLastUpdatedDate.
function queryTestRuns(project: string, minLastUpdatedDate: Date, maxLastUpdatedDate: Date, state?: TestRunState, planIds?: number[], isAutomated?: boolean, publishContext?: TestRunPublishContext, buildIds?: number[], buildDefIds?: number[], branchName?: string, releaseIds?: number[], releaseDefIds?: number[], releaseEnvIds?: number[], releaseEnvDefIds?: number[], runTitle?: string, top?: number, continuationToken?: string): Promise<PagedList<TestRun>>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- minLastUpdatedDate
-
Date
الحد الأدنى لتاريخ آخر تعديل للتشغيل للاستعلامات (إلزامي).
- maxLastUpdatedDate
-
Date
الحد الأقصى لتاريخ آخر تعديل للتشغيل المطلوب الاستعلام فيه (إلزامي، يمكن أن يكون الفرق بين الحد الأدنى والتاريخ الأقصى 7 أيام كحد أقصى).
- state
- TestRunState
الحالة الحالية لتشغيل ليتم الاستعلام.
- planIds
-
number[]
معرفات الخطة الخاصة بالشواط المراد الاستعلام عنها، قائمة مفصولة بفواصل من المعرفات الصالحة (الحد رقم المعرف 10).
- isAutomated
-
boolean
نوع التنفيذ التلقائي للتشغيلات التي سيتم الاستعلام عنها.
- publishContext
- TestRunPublishContext
PublishContext من عمليات التشغيل التي سيتم الاستعلام فيها.
- buildIds
-
number[]
إنشاء معرفات عمليات التشغيل التي سيتم الاستعلام عنها، قائمة مفصولة بفواصل من المعرفات الصالحة (الحد لا. من المعرفات 10).
- buildDefIds
-
number[]
إنشاء معرفات تعريف التشغيل للاستعلامات، قائمة مفصولة بفواصل من المعرفات الصالحة (الحد لا. من المعرفات 10).
- branchName
-
string
اسم الفرع المصدر للتشعب الذي سيتم الاستعلام عن تشغيله.
- releaseIds
-
number[]
معرفات الإصدار من عمليات التشغيل التي سيتم الاستعلام عنها، قائمة مفصولة بفواصل من المعرفات الصالحة (الحد لا. من معرفات 10).
- releaseDefIds
-
number[]
معرفات تعريف الإصدار من عمليات التشغيل التي سيتم الاستعلام عنها، قائمة مفصولة بفواصل من المعرفات الصالحة (الحد لا. من المعرفات 10).
- releaseEnvIds
-
number[]
معرفات بيئة الإصدار من عمليات التشغيل التي سيتم الاستعلام عنها، قائمة مفصولة بفواصل من المعرفات الصالحة (الحد لا. من المعرفات 10).
- releaseEnvDefIds
-
number[]
معرفات تعريف بيئة الإصدار من عمليات التشغيل التي سيتم الاستعلام عنها، قائمة مفصولة بفواصل من المعرفات الصالحة (الحد لا. من المعرفات 10).
- runTitle
-
string
تشغيل عنوان التشغيل للاستعلامات.
- top
-
number
عدد عمليات التشغيل التي سيتم الاستعلام عنها. الحد هو 100
- continuationToken
-
string
تم تلقي الرمز المميز للمتابعة من الدفعة السابقة أو القيمة الخالية للدفعة الأولى. لا يفترض أن يتم إنشاؤه (أو تغييره، إذا تم تلقيه من الدفعة الأخيرة) من قبل المستخدم.
المرتجعات
queryTestSummaryByRequirement(TestResultsContext, string, number[])
function queryTestSummaryByRequirement(resultsContext: TestResultsContext, project: string, workItemIds?: number[]): Promise<TestSummaryForWorkItem[]>
المعلمات
- resultsContext
- TestResultsContext
- project
-
string
معرف المشروع أو اسم المشروع
- workItemIds
-
number[]
المرتجعات
Promise<TestSummaryForWorkItem[]>
removeTestCasesFromSuiteUrl(string, number, number, string)
تتم إزالة نقاط الاختبار المرتبطة بحالات الاختبار من مجموعة الاختبار. لا يتم حذف عنصر عمل حالة الاختبار من النظام. راجع مورد حالات الاختبار لحذف حالة اختبار بشكل دائم.
function removeTestCasesFromSuiteUrl(project: string, planId: number, suiteId: number, testCaseIds: string): Promise<void>
المعلمات
- project
-
string
معرف المشروع أو اسم المشروع
- planId
-
number
معرف خطة الاختبار التي تحتوي على المجموعة.
- suiteId
-
number
معرف الجناح الذي يجب الحصول عليه.
- testCaseIds
-
string
معرفات حالات الاختبار المراد إزالتها من المجموعة.
المرتجعات
Promise<void>
updateCodeCoverageSummary(CodeCoverageData, string, number)
http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 طلب: Json لملخص تغطية التعليمات البرمجية
function updateCodeCoverageSummary(coverageData: CodeCoverageData, project: string, buildId: number): Promise<void>
المعلمات
- coverageData
- CodeCoverageData
- project
-
string
معرف المشروع أو اسم المشروع
- buildId
-
number
المرتجعات
Promise<void>
updateResultRetentionSettings(ResultRetentionSettings, string)
تحديث إعدادات استبقاء نتيجة الاختبار
function updateResultRetentionSettings(retentionSettings: ResultRetentionSettings, project: string): Promise<ResultRetentionSettings>
المعلمات
- retentionSettings
- ResultRetentionSettings
اختبار تفاصيل إعدادات الاحتفاظ بالنتيجة التي سيتم تحديثها
- project
-
string
معرف المشروع أو اسم المشروع
المرتجعات
Promise<ResultRetentionSettings>
updateSuiteTestCases(SuiteTestCaseUpdateModel, string, number, number, string)
يحدث خصائص اقتران حالة الاختبار في مجموعة.
function updateSuiteTestCases(suiteTestCaseUpdateModel: SuiteTestCaseUpdateModel, project: string, planId: number, suiteId: number, testCaseIds: string): Promise<SuiteTestCase[]>
المعلمات
- suiteTestCaseUpdateModel
- SuiteTestCaseUpdateModel
نموذج لتحديث خصائص اقتران مجموعة حالة الاختبار.
- project
-
string
معرف المشروع أو اسم المشروع
- planId
-
number
معرف خطة الاختبار التي تحتوي على المجموعة.
- suiteId
-
number
معرف مجموعة الاختبار التي يجب إضافة حالات الاختبار إليها.
- testCaseIds
-
string
معرفات حالات الاختبار لإضافتها إلى المجموعة. يتم تحديد المعرف بتنسيق مفصول بفواصل.
المرتجعات
Promise<SuiteTestCase[]>
updateTestPoints(PointUpdateModel, string, number, number, string)
تحديث نقاط الاختبار.
function updateTestPoints(pointUpdateModel: PointUpdateModel, project: string, planId: number, suiteId: number, pointIds: string): Promise<TestPoint[]>
المعلمات
- pointUpdateModel
- PointUpdateModel
البيانات المراد تحديثها.
- project
-
string
معرف المشروع أو اسم المشروع
- planId
-
number
معرف خطة الاختبار.
- suiteId
-
number
معرف المجموعة الذي يحتوي على النقاط.
- pointIds
-
string
معرف نقطة الاختبار التي يجب الحصول عليها. استخدم قائمة معرفات مفصولة بفواصل لتحديث نقاط اختبار متعددة.
المرتجعات
Promise<TestPoint[]>
updateTestResults(TestCaseResult[], string, number)
تحديث نتائج الاختبار في تشغيل اختبار.
function updateTestResults(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>
المعلمات
- results
قائمة بنتائج الاختبار المراد تحديثها.
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
اختبار معرف التشغيل الذي يجب تحديث نتائج الاختبار الخاصة به.
المرتجعات
Promise<TestCaseResult[]>
updateTestRun(RunUpdateModel, string, number)
اختبار التحديث الذي يتم تشغيله بواسطة معرفه.
function updateTestRun(runUpdateModel: RunUpdateModel, project: string, runId: number): Promise<TestRun>
المعلمات
- runUpdateModel
- RunUpdateModel
تشغيل تفاصيل RunUpdateModel
- project
-
string
معرف المشروع أو اسم المشروع
- runId
-
number
معرف التشغيل للتحديث.
المرتجعات
Promise<TestRun>
updateTestSession(TestSession, TeamContext)
تحديث جلسة اختبار
function updateTestSession(testSession: TestSession, teamContext: TeamContext): Promise<TestSession>
المعلمات
- testSession
- TestSession
اختبار تفاصيل جلسة العمل للتحديث
- teamContext
- TeamContext
سياق الفريق للعملية
المرتجعات
Promise<TestSession>