Поделиться через


TestRestClient class

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

Extends

Конструкторы

TestRestClient(IVssRestClientOptions)

Свойства

RESOURCE_AREA_ID

Методы

addCustomFields(CustomTestFieldDefinition[], string)
addTestCasesToSuite(string, number, number, string)

Добавьте тестовые случаи в набор.

addTestResultsToTestRun(TestCaseResult[], string, number)

Добавьте результаты теста в тестовое выполнение.

addWorkItemToTestLinks(WorkItemToTestLinks, string)
createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)

Присоединение файла к результату тестового шага

createTestResultAttachment(TestAttachmentRequestModel, string, number, number)

Подключите файл к результату теста.

createTestRun(RunCreateModel, string)

Создание тестового запуска.

createTestRunAttachment(TestAttachmentRequestModel, string, number)

Вложите файл в тестовый запуск.

createTestSession(TestSession, TeamContext)

Создание тестового сеанса

createTestSettings(TestSettings, string)
createTestSubResultAttachment(TestAttachmentRequestModel, string, number, number, number)

Присоединение файла к результату теста

deleteSharedParameter(string, number)
deleteSharedStep(string, number)
deleteTestCase(string, number)

Удаление тестового случая.

deleteTestMethodToWorkItemLink(string, string, number)
deleteTestRun(string, number)

Удалите тестовый запуск с его идентификатором.

deleteTestSettings(string, number)
getBugsLinkedToTestResult(string, number, number)
getBuildCodeCoverage(string, number, number)

Получение данных покрытия кода для сборки.

getCodeCoverageSummary(string, number, number)

Получение сводки покрытия кода для сборки.

getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)
getPoint(string, number, number, number, string)

Получение тестовой точки.

getPoints(string, number, number, string, string, string, string, boolean, number, number)

Получение списка точек тестирования.

getPointsByQuery(TestPointsQuery, string, number, number)

Получение точек тестирования с помощью запроса.

getResultGroupsByBuild(string, number, string, string[], string)
getResultGroupsByRelease(string, number, string, number, string[], string)
getResultRetentionSettings(string)

Получение параметров хранения результатов теста

getTestCaseById(string, number, number, number)

Получите конкретный тестовый случай в наборе тестов с идентификатором тестового варианта.

getTestCases(string, number, number)

Получите все тестовые случаи в наборе.

getTestIteration(string, number, number, number, boolean)

Получение итерации для результата

getTestIterations(string, number, number, boolean)

Получение итераций для результата

getTestResultAttachmentContent(string, number, number, number)

Скачайте вложение результатов теста по идентификатору.

getTestResultAttachments(string, number, number)

Получение списка ссылок на вложения результатов теста.

getTestResultAttachmentZip(string, number, number, number)

Скачайте вложение результатов теста по идентификатору.

getTestResultById(string, number, number, ResultDetails)

Получите результат теста для тестового запуска.

getTestResultDetailsForBuild(string, number, string, string, string, string, boolean, boolean)
getTestResultDetailsForRelease(string, number, number, string, string, string, string, boolean, boolean)
getTestResults(string, number, ResultDetails, number, number, TestOutcome[])

Получение результатов теста для тестового выполнения.

getTestResultsByBuild(string, number, string, TestOutcome[], number, string)
getTestResultsByQuery(TestResultsQuery, string)

Этот API вернет результаты по идентификаторам с полями, указанными или трендами для конкретного автоматизированного метода тестирования. Мы все еще улучшаем этот API и не завершили правильную подпись и контракт.

getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)
getTestRunAttachmentContent(string, number, number)

Скачайте вложения тестового запуска по его идентификатору.

getTestRunAttachments(string, number)

Получение списка ссылок на тестовые вложения запуска.

getTestRunAttachmentZip(string, number, number)

Скачайте вложения тестового запуска по его идентификатору.

getTestRunById(string, number, boolean)

Получите тестовый запуск по его идентификатору.

getTestRunCodeCoverage(string, number, number)

Получение данных покрытия кода для тестового запуска

getTestRunLogs(string, number)

Получение журналов сообщений тестового запуска

getTestRuns(string, string, string, string, number, boolean, boolean, number, number)

Получение списка тестовых запусков.

getTestRunStatistics(string, number)

Получение статистики тестового запуска, используемой при получении сводки по результатам выполнения.

getTestSessions(TeamContext, number, boolean, boolean, TestSessionSource, boolean)

Получение списка тестовых сеансов

getTestSettingsById(string, number)
getTestSubResultAttachmentContent(string, number, number, number, number)

Скачивание вложенного результата теста

getTestSubResultAttachments(string, number, number, number)

Получение списка вложенных вложений тестового результата

getTestSubResultAttachmentZip(string, number, number, number, number)

Скачивание вложенного результата теста

processSuitesForStaging(StagedSuitesRequestModel, string, number)

Обрабатывает коллекцию наборов тестов и возвращает модель ответа, содержащую сведения о наборе и тестовых случаях.

publishTestResultDocument(TestResultDocument, string, number)
queryCustomFields(string, CustomTestFieldScope)
queryResultTrendForBuild(TestResultTrendFilter, string)
queryResultTrendForRelease(TestResultTrendFilter, string)
queryTestHistory(TestHistoryQuery, string)

Получение журнала метода тестирования с помощью TestHistoryQuery

queryTestMethodLinkedWorkItems(string, string)
queryTestResultHistory(ResultsFilter, string)
queryTestResultsMetaData(string[], string)

Получение списка метаданных результатов теста для соответствующих testcasereferenceId

queryTestResultsReportForBuild(string, number, string, boolean, BuildReference)
queryTestResultsReportForRelease(string, number, number, string, boolean, ReleaseReference)
queryTestResultsSummaryForReleases(ReleaseReference[], string)
queryTestResultWorkItems(string, string, string, number, Date, number, number)
queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, string)

Выполнение тестов запросов на основе фильтров. Обязательные поля : minLastUpdatedDate и maxLastUpdatedDate.

queryTestSummaryByRequirement(TestResultsContext, string, number[])
removeTestCasesFromSuiteUrl(string, number, number, string)

Точки тестирования, связанные с тестовые случаи, удаляются из набора тестов. Рабочий элемент тестового дела не удаляется из системы. Сведения о том, как удалить тестовый случай окончательно, см. в ресурсе тестовых вариантов.

updateCodeCoverageSummary(CodeCoverageData, string, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10 Запрос: Json сводки покрытия кода

updateResultRetentionSettings(ResultRetentionSettings, string)

Обновление параметров хранения результатов теста

updateSuiteTestCases(SuiteTestCaseUpdateModel, string, number, number, string)

Обновляет свойства сопоставления тестового случая в наборе.

updateTestPoints(PointUpdateModel, string, number, number, string)

Обновление точек тестирования.

updateTestResults(TestCaseResult[], string, number)

Обновление результатов теста в тестовом выполнении.

updateTestRun(RunUpdateModel, string, number)

Обновление тестового запуска по идентификатору.

updateTestSession(TestSession, TeamContext)

Обновление тестового сеанса

Сведения о конструкторе

TestRestClient(IVssRestClientOptions)

new TestRestClient(options: IVssRestClientOptions)

Параметры

Сведения о свойстве

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Значение свойства

string

Сведения о методе

addCustomFields(CustomTestFieldDefinition[], string)

function addCustomFields(newFields: CustomTestFieldDefinition[], project: string): Promise<CustomTestFieldDefinition[]>

Параметры

project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

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

TestCaseResult[]

Список результатов теста для добавления.

project

string

Идентификатор проекта или имя проекта

runId

number

Идентификатор тестового запуска, в который нужно добавить результаты теста.

Возвращаемое значение

Promise<TestCaseResult[]>

function addWorkItemToTestLinks(workItemToTestLinks: WorkItemToTestLinks, project: string): Promise<WorkItemToTestLinks>

Параметры

workItemToTestLinks
WorkItemToTestLinks
project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

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

Шестнадцатеричное значение пути действия результата теста.

Возвращаемое значение

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

Идентификатор результата теста, в котором должно быть отправлено вложение.

Возвращаемое значение

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

Идентификатор тестового выполнения, в котором необходимо отправить вложение.

Возвращаемое значение

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

Идентификатор тестовых вложенных результатов, в отношении которых должно быть отправлено вложение.

Возвращаемое значение

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>

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

Идентификатор delta Build (необязательно)

Возвращаемое значение

getLinkedWorkItemsByQuery(LinkedWorkItemsQuery, string)

function getLinkedWorkItemsByQuery(workItemQuery: LinkedWorkItemsQuery, project: string): Promise<LinkedWorkItemsQueryResult[]>

Параметры

workItemQuery
LinkedWorkItemsQuery
project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

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

Возвращаемое значение

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

Возвращаемое значение

getResultRetentionSettings(string)

Получение параметров хранения результатов теста

function getResultRetentionSettings(project: string): Promise<ResultRetentionSettings>

Параметры

project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

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 и параметры теста в разделе параметров для каждой итерации теста.

Возвращаемое значение

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 и параметры теста в разделе параметров для каждой итерации теста.

Возвращаемое значение

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

Сведения о включении с результатами теста. Значение по умолчанию — None. Другие значения: итерации, 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

Возвращаемое значение

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

Возвращаемое значение

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

Сведения о включении с результатами теста. Значение по умолчанию — None. Другими значениями являются итерации и WorkItems.

skip

number

Количество результатов теста, которые нужно пропустить с начала.

top

number

Количество возвращаемых результатов теста. Максимальное значение равно 1000, если значение detailsToInclude равно None и 200 в противном случае.

outcomes

TestOutcome[]

Разделенный запятыми список результатов теста для фильтрации результатов теста.

Возвращаемое значение

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

TestOutcome[]

top

number

continuationToken

string

Возвращаемое значение

getTestResultsByQuery(TestResultsQuery, string)

Этот API вернет результаты по идентификаторам с полями, указанными или трендами для конкретного автоматизированного метода тестирования. Мы все еще улучшаем этот API и не завершили правильную подпись и контракт.

function getTestResultsByQuery(query: TestResultsQuery, project: string): Promise<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

TestOutcome[]

top

number

continuationToken

string

Возвращаемое значение

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

Значение по умолчанию — true. Она содержит сведения, такие как статистика выполнения, выпуск, сборка, тестовая среда, состояние после процесса и многое другое.

Возвращаемое значение

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

Идентификатор запуска для получения.

Возвращаемое значение

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

Если значение true, включите все свойства выполнения.

automated

boolean

Если значение true, возвращается только автоматические запуски.

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

Если значение false, возвращает тестовые сеансы для текущего пользователя. В противном случае он возвращает тестовые сеансы для всех пользователей

includeAllProperties

boolean

Если значение true, оно возвращает все свойства тестовых сеансов. В противном случае возвращается тощая версия.

source
TestSessionSource

Источник тестового сеанса.

includeOnlyCompletedSessions

boolean

Если значение true, оно возвращает тестовые сеансы в состоянии завершения. В противном случае он возвращает тестовые сеансы для всех состояний

Возвращаемое значение

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

Модель запроса, содержащая наборы тестов, которые необходимо обработать. Не может быть null.

project

string

Идентификатор проекта или имя проекта

workItemId

number

Возвращаемое значение

publishTestResultDocument(TestResultDocument, string, number)

function publishTestResultDocument(document: TestResultDocument, project: string, runId: number): Promise<TestResultDocument>

Параметры

project

string

Идентификатор проекта или имя проекта

runId

number

Возвращаемое значение

queryCustomFields(string, CustomTestFieldScope)

function queryCustomFields(project: string, scopeFilter: CustomTestFieldScope): Promise<CustomTestFieldDefinition[]>

Параметры

project

string

Идентификатор проекта или имя проекта

scopeFilter
CustomTestFieldScope

Возвращаемое значение

queryResultTrendForBuild(TestResultTrendFilter, string)

function queryResultTrendForBuild(filter: TestResultTrendFilter, project: string): Promise<AggregatedDataForResultTrend[]>

Параметры

project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

queryResultTrendForRelease(TestResultTrendFilter, string)

function queryResultTrendForRelease(filter: TestResultTrendFilter, project: string): Promise<AggregatedDataForResultTrend[]>

Параметры

project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

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

Возвращаемое значение

queryTestResultHistory(ResultsFilter, string)

function queryTestResultHistory(filter: ResultsFilter, project: string): Promise<TestResultHistory>

Параметры

filter
ResultsFilter
project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

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

Возвращаемое значение

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

Возвращаемое значение

queryTestResultsSummaryForReleases(ReleaseReference[], string)

function queryTestResultsSummaryForReleases(releases: ReleaseReference[], project: string): Promise<TestResultSummary[]>

Параметры

releases

ReleaseReference[]

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

continuationToken, полученный из предыдущего пакета или null для первого пакета. Он не должен быть создан (или изменен, если получен из последней пакетной службы) пользователем.

Возвращаемое значение

Promise<PagedList<TestRun>>

queryTestSummaryByRequirement(TestResultsContext, string, number[])

function queryTestSummaryByRequirement(resultsContext: TestResultsContext, project: string, workItemIds?: number[]): Promise<TestSummaryForWorkItem[]>

Параметры

resultsContext
TestResultsContext
project

string

Идентификатор проекта или имя проекта

workItemIds

number[]

Возвращаемое значение

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

Идентификатор проекта или имя проекта

Возвращаемое значение

updateSuiteTestCases(SuiteTestCaseUpdateModel, string, number, number, string)

Обновляет свойства сопоставления тестового случая в наборе.

function updateSuiteTestCases(suiteTestCaseUpdateModel: SuiteTestCaseUpdateModel, project: string, planId: number, suiteId: number, testCaseIds: string): Promise<SuiteTestCase[]>

Параметры

suiteTestCaseUpdateModel
SuiteTestCaseUpdateModel

Модель для updation свойств сопоставления наборов тестовых вариантов.

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

TestCaseResult[]

Список результатов теста для обновления.

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>