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


TestResultsRestClient class

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

Расширяет

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

TestResultsRestClient(IVssRestClientOptions)

Свойства

RESOURCE_AREA_ID

Методика

addCustomFields(CustomTestFieldDefinition[], string)

Создает настраиваемые поля тестирования на основе предоставленных данных.

addTestResultsToTestRun(TestCaseResult[], string, number)
addTestResultsToTestRunSession(TestCaseResult[], string, number)

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

addWorkItemToTestLinks(WorkItemToTestLinks, string)
createAnalysis(TestSessionAnalysis[], string, number)

Создает объект анализа сеансов в хранилище данных TCM для данного сеанса

createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)

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

createEnvironment(TestSessionEnvironment[], string)

Создает объект Среды в хранилище данных TCM

createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)

Для предоставленного идентификатора сеанса создает среду, конфигурацию и объекты компьютера в хранилище данных TCM

createFailureType(TestResultFailureTypeRequestModel, string)

Создает новый тип сбоя теста

createNotification(TestSessionNotification[], string, number)

Создает объект Notification в хранилище данных TCM для заданного сеанса

createTestIterationResultAttachment(TestAttachmentRequestModel, string, number, number, number, string)
createTestResultAttachment(TestAttachmentRequestModel, string, number, number)
createTestResultMachines(TestResultMachine[], string, number)

Создает компьютеры результатов теста для предоставленного TestRunId

createTestRun(RunCreateModel, string)
createTestRunAttachment(TestAttachmentRequestModel, string, number)
createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)

Создает вложение в LogStore для указанного runId.

createTestSession(TestResultsSession, string)

Создает объект TestResultsSession в хранилище данных TCM

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

Возвращает сведения о настраиваемом поле тестирования для указанного testExtensionFieldId.

deleteFailureType(string, number)

Удаляет тип тестового сбоя с указанным типом failureTypeId

deleteFlakyTestCaseRefIdsByBranch(string, BranchInfo)

Удалять нестабильные идентификаторы тестового случая по информации о ветвях

deleteTestMethodToWorkItemLink(string, string, number)
deleteTestResultAttachment(string, number, number, number)
deleteTestRun(string, number)
deleteTestRunAttachment(string, number, number)
deleteTestRunLogStoreAttachment(string, number, string)

Удаляет вложение с указанным именем файла для указанного runId из LogStore.

deleteTestSettings(string, number)
fetchSourceCodeCoverageReport(string, number)
generateTestPlanFromWorkItem(GenerateTestPlanFromWorkItemModel, string, number)

Создание плана тестирования вручную на основе рабочего элемента с помощью ИИ

getAfdTcmEndpoint(string)
getBranchesByFlakyTestCaseRefId(string, number)

Получение списка ветвей, в которых отслоился идентификатор ссылки на тестовый случай

getBugsLinkedToTestResult(string, number, number)
getBuildCodeCoverage(string, number, number)
getCodeCoverageSummary(string, number, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10&deltaBuildId=9 Request: идентификатор сборки и идентификатор разностной сборки (необязательно)

getCoverageStatusBadge(string, string, string, string)

<p>Возвращает состояние покрытия для последней успешной сборки определения, при необходимости в пределах определенной ветви</p>

getFailureTypes(string)

Возвращает список типов тестового сбоя.

getFileLevelCodeCoverage(FileCoverageRequest, string)

Получение охвата файла для указанного файла

getFlakyTestCaseRefIdsByBranch(string, string, BranchInfo)
getFlakyTestResultsByBuildDefinitionId(string, number, Date)
getFlakyTestResultsByTestRun(string, number)
getResultGroupsByBuild(string, number, string, string[], string)
getResultGroupsByRelease(string, number, string, number, string[], string)
getSessionNotifications(string, number)

Извлекает объекты Уведомлений TestResultsSession в хранилище данных TCM

getSimilarTestResults(string, number, number, number, number, String)

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

getTestIterationAttachmentContent(string, number, number, number, number)

Возвращает вложение тестовой итерации

getTestIterationAttachmentZip(string, number, number, number, number)

Возвращает вложение тестовой итерации

getTestLogsForBuild(string, number, TestLogType, string, string, boolean, number, String)

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

getTestLogStoreEndpointDetailsForBuildLog(string, number, TestLogType, string)

Получение URI SAS для вложения сборки

getTestLogStoreEndpointDetailsForResultLog(string, number, number, TestLogType, string)

Получение URI SAS для вложения результатов теста

getTestLogStoreEndpointDetailsForRunLog(string, number, TestLogType, string)

Получение URI SAS для вложения тестового запуска

getTestLogStoreEndpointDetailsForSubResultLog(string, number, number, number, TestLogType, string)

Получение URI SAS для вложения тестового подресулта

getTestPipelineMetrics(string, number, string, string, string, Metrics[], 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)
getTestResultLogs(string, number, number, TestLogType, string, string, boolean, number, String)

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

getTestResultMachines(string, number)

Возвращает компьютеры результатов теста для предоставленного TestRunId

getTestResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)
getTestResultsByBuild(string, number, string, TestOutcome[], number, string)
getTestResultsByPipeline(string, number, string, string, string, TestOutcome[], boolean, number, String)

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

getTestResultsByPipelineMRX(string, number, string, string, string, TestOutcome[], boolean, number, String)

Возвращает полные объекты TestCaseResult с подробными сведениями 1MRX для предоставленного конвейера

getTestResultsByQuery(TestResultsQuery, string)
getTestResultsByQueryWiql(QueryModel, string, boolean, boolean, number, number)
getTestResultsByRelease(string, number, number, string, TestOutcome[], number, string)
getTestResultsSettings(string, TestResultsSettingsType)

Получение данных TestResultsSettings

getTestResultWorkItemsById(string, number, number)
getTestRunAttachmentContent(string, number, number)

Возвращает вложение тестового запуска

getTestRunAttachments(string, number)
getTestRunAttachmentZip(string, number, number)

Возвращает вложение тестового запуска

getTestRunById(string, number, boolean, boolean)
getTestRunCodeCoverage(string, number, number)
getTestRunLogs(string, number, TestLogType, string, string, boolean, number, String)

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

getTestRunLogStoreAttachmentContent(string, number, string)

Возвращает вложение с указанным именем файла для указанного runId из LogStore.

getTestRunLogStoreAttachments(string, number)

Возвращает список вложений для указанного runId из LogStore.

getTestRunLogStoreAttachmentZip(string, number, string)

Возвращает вложение с указанным именем файла для указанного runId из LogStore.

getTestRunMessageLogs(string, number)

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

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

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

getTestRunStatistics(string, number)

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

getTestRunSummaryByOutcome(string, number)

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

getTestSession(string, number)

Извлекает объект метаданных TestResultsSession в хранилище данных TCM

getTestSessionLayout(string, string)

Извлекает объект Layout TestResultsSession в хранилище данных TCM

getTestSessionLayoutBySessionId(string, number)

Извлекает объект Layout TestResultsSession в хранилище данных TCM

getTestSessionResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)
getTestSettingsById(string, number)
getTestSubResultAttachmentContent(string, number, number, number, number)

Возвращает вложенное вложение тестового результата

getTestSubResultAttachments(string, number, number, number)

Возвращает ссылки на вложения для тестового вложенного результата.

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

Возвращает вложенное вложение тестового результата

getTestSubResultLogs(string, number, number, number, TestLogType, string, string, boolean, number, String)

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

getTestTagsForBuild(string, number)

Получение всех тегов в сборке.

getTestTagsForRelease(string, number, number)

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

getTestTagSummaryForBuild(string, number)

Получение всех тегов в сборке.

getTestTagSummaryForRelease(string, number, number)

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

getTestWeightedScoreByBuild(string, number, boolean, boolean)
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, ResultMetaDataDetails)

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

queryTestResultsReportForBuild(string, number, string, boolean, BuildReference)
queryTestResultsReportForPipeline(string, number, string, string, string, boolean)

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

queryTestResultsReportForRelease(string, number, number, string, boolean, ReleaseReference)
queryTestResultsSummaryForReleases(ReleaseReference[], string)
queryTestResultWorkItems(string, string, string, number, Date, number, number)

Результаты теста запросов WorkItems на основе фильтра

queryTestRuns(string, Date, Date, TestRunState, number[], boolean, TestRunPublishContext, number[], number[], string, number[], number[], number[], number[], string, number, TestRunSortOrderType, string)

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

queryTestSummaryByRequirement(TestResultsContext, string, number[])
testLogStoreEndpointDetailsForBuild(string, number, TestLogStoreOperationType)

Создание и получение URI sas контейнера сборки

testLogStoreEndpointDetailsForResult(string, number, number, number, string, TestLogType)

Создание пустого файла для результата и получение URI Sas для файла

testLogStoreEndpointDetailsForRun(string, number, TestLogStoreOperationType, string, TestLogType)

Создание пустого файла для запуска и получения URI Sas для файла

testResultsGroupDetails(string, number, string, string, string, boolean, boolean)

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

updateCodeCoverageSummary(string, number, CodeCoverageData)

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

updateCustomField(CustomTestFieldUpdateDefinition, string)

Возвращает сведения о настраиваемом поле теста, которое обновляется.

updatePipelinesTestSettings(TestResultsUpdateSettings, string)

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

updateTestResults(TestCaseResult[], string, number)
updateTestResultsMetaData(TestResultMetaDataUpdateInput, string, number)

Обновление свойств метаданных результатов теста

updateTestResultsToTestRunSession(TestCaseResult[], string, number)

Создает объекты TestResultsMRX в хранилище данных TCM для существующих результатов теста

updateTestRun(RunUpdateModel, string, number)
updateTestRunsBySessionId(TestSessionTestRun, string, number)

Обновление тестов, связанных с сеансом

updateTestRunTags(TestTagsUpdateModel, string, number)

Обновление тегов выполнения, теги можно добавить и удалить

updateTestSession(TestResultsSession, string, number)

Обновляет объект тестового сеанса, связанный с идентификатором сеанса

Подробнее о конструкторе

TestResultsRestClient(IVssRestClientOptions)

new TestResultsRestClient(options: IVssRestClientOptions)

Параметры

Подробнее

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Стоимость недвижимости

string

Подробнее о методе

addCustomFields(CustomTestFieldDefinition[], string)

Создает настраиваемые поля тестирования на основе предоставленных данных.

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

Параметры

newFields

CustomTestFieldDefinition[]

NewFields — это массив типа CustomTestFieldDefinition.

project

string

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

Возвращает

addTestResultsToTestRun(TestCaseResult[], string, number)

function addTestResultsToTestRun(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>

Параметры

results

TestCaseResult[]

project

string

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

runId

number

Возвращает

Promise<TestCaseResult[]>

addTestResultsToTestRunSession(TestCaseResult[], string, number)

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

function addTestResultsToTestRunSession(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>

Параметры

results

TestCaseResult[]

project

string

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

runId

number

RunId тестового запуска

Возвращает

Promise<TestCaseResult[]>

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

Параметры

workItemToTestLinks
WorkItemToTestLinks
project

string

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

Возвращает

createAnalysis(TestSessionAnalysis[], string, number)

Создает объект анализа сеансов в хранилище данных TCM для данного сеанса

function createAnalysis(analysis: TestSessionAnalysis[], project: string, sessionId: number): Promise<AnalysisFailureGroupReturn[]>

Параметры

analysis

TestSessionAnalysis[]

Сведения о анализе сеансов

project

string

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

sessionId

number

Идентификатор сеанса для добавления уведомления

Возвращает

createBuildAttachmentInLogStore(TestAttachmentRequestModel, string, number)

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

function createBuildAttachmentInLogStore(attachmentRequestModel: TestAttachmentRequestModel, project: string, buildId: number): Promise<void>

Параметры

attachmentRequestModel
TestAttachmentRequestModel

Содержит сведения о вложениях, например stream, filename, comment, attachmentType

project

string

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

buildId

number

BuildId

Возвращает

Promise<void>

createEnvironment(TestSessionEnvironment[], string)

Создает объект Среды в хранилище данных TCM

function createEnvironment(environments: TestSessionEnvironment[], project: string): Promise<void>

Параметры

environments

TestSessionEnvironment[]

Полученный объект Environment.

project

string

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

Возвращает

Promise<void>

createEnvironmentAndMachine(SessionEnvironmentAndMachine, string, number)

Для предоставленного идентификатора сеанса создает среду, конфигурацию и объекты компьютера в хранилище данных TCM

function createEnvironmentAndMachine(sessionEnvironmentAndMachine: SessionEnvironmentAndMachine, project: string, sessionId: number): Promise<void>

Параметры

sessionEnvironmentAndMachine
SessionEnvironmentAndMachine
project

string

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

sessionId

number

Возвращает

Promise<void>

createFailureType(TestResultFailureTypeRequestModel, string)

Создает новый тип сбоя теста

function createFailureType(testResultFailureType: TestResultFailureTypeRequestModel, project: string): Promise<TestResultFailureType>

Параметры

testResultFailureType
TestResultFailureTypeRequestModel
project

string

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

Возвращает

createNotification(TestSessionNotification[], string, number)

Создает объект Notification в хранилище данных TCM для заданного сеанса

function createNotification(notifications: TestSessionNotification[], project: string, sessionId: number): Promise<number[]>

Параметры

notifications

TestSessionNotification[]

Уведомления для добавления для указанного идентификатора сеанса

project

string

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

sessionId

number

Идентификатор сеанса для добавления уведомления

Возвращает

Promise<number[]>

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

string

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

runId

number

testCaseResultId

number

Возвращает

createTestResultMachines(TestResultMachine[], string, number)

Создает компьютеры результатов теста для предоставленного TestRunId

function createTestResultMachines(testResultMachines: TestResultMachine[], project: string, runId: number): Promise<void>

Параметры

testResultMachines

TestResultMachine[]

Список компьютеров для результатов тестирования во время выполнения

project

string

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

runId

number

Идентификатор TestRun для добавления компьютеров

Возвращает

Promise<void>

createTestRun(RunCreateModel, string)

function createTestRun(testRun: RunCreateModel, project: string): Promise<TestRun>

Параметры

testRun
RunCreateModel
project

string

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

Возвращает

Promise<TestRun>

createTestRunAttachment(TestAttachmentRequestModel, string, number)

function createTestRunAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number): Promise<TestAttachmentReference>

Параметры

attachmentRequestModel
TestAttachmentRequestModel
project

string

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

runId

number

Возвращает

createTestRunLogStoreAttachment(TestAttachmentRequestModel, string, number)

Создает вложение в LogStore для указанного runId.

function createTestRunLogStoreAttachment(attachmentRequestModel: TestAttachmentRequestModel, project: string, runId: number): Promise<TestLogStoreAttachmentReference>

Параметры

attachmentRequestModel
TestAttachmentRequestModel

Содержит сведения о вложениях, например stream, filename, comment, attachmentType

project

string

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

runId

number

Тестовый идентификатор runId

Возвращает

createTestSession(TestResultsSession, string)

Создает объект TestResultsSession в хранилище данных TCM

function createTestSession(session: TestResultsSession, project: string): Promise<number>

Параметры

session
TestResultsSession

Полученный объект сеанса.

project

string

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

Возвращает

Promise<number>

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

Возвращает

deleteCustomFieldById(string, number)

Возвращает сведения о настраиваемом поле тестирования для указанного testExtensionFieldId.

function deleteCustomFieldById(project: string, testExtensionFieldId: number): Promise<void>

Параметры

project

string

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

testExtensionFieldId

number

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

Возвращает

Promise<void>

deleteFailureType(string, number)

Удаляет тип тестового сбоя с указанным типом failureTypeId

function deleteFailureType(project: string, failureTypeId: number): Promise<void>

Параметры

project

string

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

failureTypeId

number

Возвращает

Promise<void>

deleteFlakyTestCaseRefIdsByBranch(string, BranchInfo)

Удалять нестабильные идентификаторы тестового случая по информации о ветвях

function deleteFlakyTestCaseRefIdsByBranch(project: string, branchInfo: BranchInfo): Promise<number>

Параметры

project

string

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

branchInfo
BranchInfo

Информация о ветке с названием и типом

Возвращает

Promise<number>

function deleteTestMethodToWorkItemLink(project: string, testName: string, workItemId: number): Promise<boolean>

Параметры

project

string

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

testName

string

workItemId

number

Возвращает

Promise<boolean>

deleteTestResultAttachment(string, number, number, number)

function deleteTestResultAttachment(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<void>

Параметры

project

string

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

runId

number

testCaseResultId

number

attachmentId

number

Возвращает

Promise<void>

deleteTestRun(string, number)

function deleteTestRun(project: string, runId: number): Promise<void>

Параметры

project

string

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

runId

number

Возвращает

Promise<void>

deleteTestRunAttachment(string, number, number)

function deleteTestRunAttachment(project: string, runId: number, attachmentId: number): Promise<void>

Параметры

project

string

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

runId

number

attachmentId

number

Возвращает

Promise<void>

deleteTestRunLogStoreAttachment(string, number, string)

Удаляет вложение с указанным именем файла для указанного runId из LogStore.

function deleteTestRunLogStoreAttachment(project: string, runId: number, filename: string): Promise<void>

Параметры

project

string

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

runId

number

Тестовый идентификатор runId

filename

string

Имя файла вложения

Возвращает

Promise<void>

deleteTestSettings(string, number)

function deleteTestSettings(project: string, testSettingsId: number): Promise<void>

Параметры

project

string

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

testSettingsId

number

Возвращает

Promise<void>

fetchSourceCodeCoverageReport(string, number)

function fetchSourceCodeCoverageReport(project: string, buildId: number): Promise<SourceViewBuildCoverage[]>

Параметры

project

string

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

buildId

number

Возвращает

generateTestPlanFromWorkItem(GenerateTestPlanFromWorkItemModel, string, number)

Создание плана тестирования вручную на основе рабочего элемента с помощью ИИ

function generateTestPlanFromWorkItem(generateTestPlanFromWorkItemModel: GenerateTestPlanFromWorkItemModel, project: string, workItemId: number): Promise<boolean>

Параметры

generateTestPlanFromWorkItemModel
GenerateTestPlanFromWorkItemModel
project

string

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

workItemId

number

Возвращает

Promise<boolean>

getAfdTcmEndpoint(string)

function getAfdTcmEndpoint(key: string): Promise<string>

Параметры

key

string

Возвращает

Promise<string>

getBranchesByFlakyTestCaseRefId(string, number)

Получение списка ветвей, в которых отслоился идентификатор ссылки на тестовый случай

function getBranchesByFlakyTestCaseRefId(project: string, testCaseReferenceId: number): Promise<TestCaseFlakinessBranchInfo>

Параметры

project

string

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

testCaseReferenceId

number

Ссылочный идентификатор используемого теста по результату теста

Возвращает

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

Возвращает

Promise<BuildCoverage[]>

getCodeCoverageSummary(string, number, number)

http://(tfsserver):8080/tfs/DefaultCollection/_apis/test/CodeCoverage?buildId=10&deltaBuildId=9 Request: идентификатор сборки и идентификатор разностной сборки (необязательно)

function getCodeCoverageSummary(project: string, buildId: number, deltaBuildId?: number): Promise<CodeCoverageSummary>

Параметры

project

string

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

buildId

number

deltaBuildId

number

Возвращает

getCoverageStatusBadge(string, string, string, string)

<p>Возвращает состояние покрытия для последней успешной сборки определения, при необходимости в пределах определенной ветви</p>

function getCoverageStatusBadge(project: string, definition: string, branchName?: string, label?: string): Promise<string>

Параметры

project

string

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

definition

string

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

branchName

string

Имя ветви.

label

string

Строка для замены текста по умолчанию в левой части значка.

Возвращает

Promise<string>

getFailureTypes(string)

Возвращает список типов тестового сбоя.

function getFailureTypes(project: string): Promise<TestResultFailureType[]>

Параметры

project

string

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

Возвращает

getFileLevelCodeCoverage(FileCoverageRequest, string)

Получение охвата файла для указанного файла

function getFileLevelCodeCoverage(fileCoverageRequest: FileCoverageRequest, project: string): Promise<string>

Параметры

fileCoverageRequest
FileCoverageRequest

Сведения о файле с контекстом итерации запроса на вытягивание

project

string

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

Возвращает

Promise<string>

getFlakyTestCaseRefIdsByBranch(string, string, BranchInfo)

function getFlakyTestCaseRefIdsByBranch(project: string, repositoryId: string, branchInfo: BranchInfo): Promise<TestCaseFlakinessBranchInfo[]>

Параметры

project

string

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

repositoryId

string

branchInfo
BranchInfo

Возвращает

getFlakyTestResultsByBuildDefinitionId(string, number, Date)

function getFlakyTestResultsByBuildDefinitionId(project: string, buildDefinitionId: number, minBuildCreatedDate: Date): Promise<TestCaseResult[]>

Параметры

project

string

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

buildDefinitionId

number

minBuildCreatedDate

Date

Возвращает

Promise<TestCaseResult[]>

getFlakyTestResultsByTestRun(string, number)

function getFlakyTestResultsByTestRun(project: string, runId: number): Promise<TestCaseResult[]>

Параметры

project

string

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

runId

number

Возвращает

Promise<TestCaseResult[]>

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

Возвращает

getSessionNotifications(string, number)

Извлекает объекты Уведомлений TestResultsSession в хранилище данных TCM

function getSessionNotifications(project: string, sessionId: number): Promise<TestSessionNotification[]>

Параметры

project

string

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

sessionId

number

Идентификатор сеанса TestResults для получения уведомлений.

Возвращает

getSimilarTestResults(string, number, number, number, number, String)

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

function getSimilarTestResults(project: string, runId: number, testResultId: number, testSubResultId: number, top?: number, continuationToken?: String): Promise<TestCaseResult[]>

Параметры

project

string

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

runId

number

Идентификатор тестового запуска

testResultId

number

Идентификатор результата теста внутри тестового запуска

testSubResultId

number

идентификатор подресулов внутри результата теста

top

number

Максимальное количество возвращаемых результатов

continuationToken

String

Заголовок для передачи продолженияToken

Возвращает

Promise<TestCaseResult[]>

getTestIterationAttachmentContent(string, number, number, number, number)

Возвращает вложение тестовой итерации

function getTestIterationAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number, iterationId: number): Promise<ArrayBuffer>

Параметры

project

string

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

runId

number

testCaseResultId

number

attachmentId

number

iterationId

number

Возвращает

Promise<ArrayBuffer>

getTestIterationAttachmentZip(string, number, number, number, number)

Возвращает вложение тестовой итерации

function getTestIterationAttachmentZip(project: string, runId: number, testCaseResultId: number, attachmentId: number, iterationId: number): Promise<ArrayBuffer>

Параметры

project

string

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

runId

number

testCaseResultId

number

attachmentId

number

iterationId

number

Возвращает

Promise<ArrayBuffer>

getTestLogsForBuild(string, number, TestLogType, string, string, boolean, number, String)

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

function getTestLogsForBuild(project: string, buildId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

Параметры

project

string

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

buildId

number

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

type
TestLogType

тип вложения для получения

directoryPath

string

Путь к каталогу, для которого требуются вложения

fileNamePrefix

string

Префикс имени файла для фильтрации списка вложений

fetchMetaData

boolean

Значение по умолчанию равно false, если требуются метаданные

top

number

Количество ссылок на тестовые вложения для возврата

continuationToken

String

Заголовок для передачи продолженияToken

Возвращает

Promise<PagedList<TestLog>>

getTestLogStoreEndpointDetailsForBuildLog(string, number, TestLogType, string)

Получение URI SAS для вложения сборки

function getTestLogStoreEndpointDetailsForBuildLog(project: string, build: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

Параметры

project

string

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

build

number

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

type
TestLogType

тип файла

filePath

string

filePath, для которого необходим URI sas

Возвращает

getTestLogStoreEndpointDetailsForResultLog(string, number, number, TestLogType, string)

Получение URI SAS для вложения результатов теста

function getTestLogStoreEndpointDetailsForResultLog(project: string, runId: number, resultId: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

Параметры

project

string

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

runId

number

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

resultId

number

Идентификатор результата теста, файлы которого необходимо скачать

type
TestLogType

тип файла

filePath

string

filePath, для которого необходим URI sas

Возвращает

getTestLogStoreEndpointDetailsForRunLog(string, number, TestLogType, string)

Получение URI SAS для вложения тестового запуска

function getTestLogStoreEndpointDetailsForRunLog(project: string, runId: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

Параметры

project

string

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

runId

number

Идентификатор тестового запуска, файл которого необходимо скачать

type
TestLogType

тип файла

filePath

string

filePath, для которого необходим URI sas

Возвращает

getTestLogStoreEndpointDetailsForSubResultLog(string, number, number, number, TestLogType, string)

Получение URI SAS для вложения тестового подресулта

function getTestLogStoreEndpointDetailsForSubResultLog(project: string, runId: number, resultId: number, subResultId: number, type: TestLogType, filePath: string): Promise<TestLogStoreEndpointDetails>

Параметры

project

string

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

runId

number

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

resultId

number

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

subResultId

number

Идентификатор тестового подресульта, uri файла sas которого необходим

type
TestLogType

тип файла

filePath

string

filePath, для которого необходим URI sas

Возвращает

getTestPipelineMetrics(string, number, string, string, string, Metrics[], boolean)

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

function getTestPipelineMetrics(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, metricNames?: Metrics[], groupByNode?: boolean): Promise<PipelineTestMetrics>

Параметры

project

string

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

pipelineId

number

Идентификатор конвейера. Это совпадает с идентификатором сборки.

stageName

string

Имя этапа. Максимальная поддерживаемая длина имени — 256 символов.

phaseName

string

Имя этапа. Максимальная поддерживаемая длина имени — 256 символов.

jobName

string

Матрица в YAML создает копии задания с различными входными данными в матрице. JobName — это имя входных данных. Максимальная поддерживаемая длина имени — 256 символов.

metricNames

Metrics[]

groupByNode

boolean

Сводка по группам для каждого узла иерархии pipleine

Возвращает

getTestResultAttachmentContent(string, number, number, number)

Возвращает вложение результатов теста

function getTestResultAttachmentContent(project: string, runId: number, testCaseResultId: number, attachmentId: number): Promise<ArrayBuffer>

Параметры

project

string

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

runId

number

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

number

attachmentId

number

Возвращает

Promise<ArrayBuffer>

getTestResultById(string, number, number, ResultDetails)

function getTestResultById(project: string, runId: number, testResultId: number, detailsToInclude?: ResultDetails): Promise<TestCaseResult>

Параметры

project

string

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

runId

number

testResultId

number

detailsToInclude
ResultDetails

Возвращает

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

Возвращает

getTestResultLogs(string, number, number, TestLogType, string, string, boolean, number, String)

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

function getTestResultLogs(project: string, runId: number, resultId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

Параметры

project

string

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

runId

number

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

resultId

number

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

type
TestLogType

тип вложений для получения

directoryPath

string

Путь к каталогу вложений для получения

fileNamePrefix

string

Префикс имени файла для фильтрации списка вложений

fetchMetaData

boolean

Значение по умолчанию равно false, если требуются метаданные

top

number

Число ссылок на вложения для возврата

continuationToken

String

Заголовок для передачи продолженияToken

Возвращает

Promise<PagedList<TestLog>>

getTestResultMachines(string, number)

Возвращает компьютеры результатов теста для предоставленного TestRunId

function getTestResultMachines(project: string, runId: number): Promise<TestResultMachine[]>

Параметры

project

string

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

runId

number

Идентификатор TestRun для добавления компьютеров

Возвращает

Promise<TestResultMachine[]>

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

function getTestResults(project: string, runId: number, detailsToInclude?: ResultDetails, skip?: number, top?: number, outcomes?: TestOutcome[], newTestsOnly?: boolean): Promise<TestCaseResult[]>

Параметры

project

string

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

runId

number

detailsToInclude
ResultDetails
skip

number

top

number

outcomes

TestOutcome[]

newTestsOnly

boolean

Возвращает

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

Возвращает

getTestResultsByPipeline(string, number, string, string, string, TestOutcome[], boolean, number, String)

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

function getTestResultsByPipeline(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, outcomes?: TestOutcome[], includeAllBuildRuns?: boolean, top?: number, continuationToken?: String): Promise<PagedList<ShallowTestCaseResult>>

Параметры

project

string

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

pipelineId

number

Идентификатор конвейера. Это совпадает с идентификатором сборки.

stageName

string

Имя этапа. Максимальная поддерживаемая длина имени — 256 символов.

phaseName

string

Имя этапа. Максимальная поддерживаемая длина имени — 256 символов.

jobName

string

Матрица в YAML создает копии задания с различными входными данными в матрице. JobName — это имя входных данных. Максимальная поддерживаемая длина имени — 256 символов.

outcomes

TestOutcome[]

Список результатов

includeAllBuildRuns

boolean

Следует ли включать тестовые запуски из всех запусков сборки или нет.

top

number

Максимальное количество возвращаемых результатов

continuationToken

String

Заголовок для передачи продолженияToken

Возвращает

getTestResultsByPipelineMRX(string, number, string, string, string, TestOutcome[], boolean, number, String)

Возвращает полные объекты TestCaseResult с подробными сведениями 1MRX для предоставленного конвейера

function getTestResultsByPipelineMRX(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, outcomes?: TestOutcome[], includeAllBuildRuns?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestCaseResult>>

Параметры

project

string

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

pipelineId

number

Идентификатор конвейера. Это совпадает с идентификатором сборки.

stageName

string

Имя этапа. Максимальная поддерживаемая длина имени — 256 символов.

phaseName

string

Имя этапа. Максимальная поддерживаемая длина имени — 256 символов.

jobName

string

Матрица в YAML создает копии задания с различными входными данными в матрице. JobName — это имя входных данных. Максимальная поддерживаемая длина имени — 256 символов.

outcomes

TestOutcome[]

Список результатов

includeAllBuildRuns

boolean

Следует ли включать тестовые запуски из всех запусков сборки или нет. По умолчанию false.

top

number

Максимальное количество возвращаемых результатов. По умолчанию — 10000.

continuationToken

String

Заголовок для передачи продолженияToken

Возвращает

getTestResultsByQuery(TestResultsQuery, string)

function getTestResultsByQuery(query: TestResultsQuery, project: string): Promise<TestResultsQuery>

Параметры

project

string

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

Возвращает

Promise<TestResultsQuery>

getTestResultsByQueryWiql(QueryModel, string, boolean, boolean, number, number)

function getTestResultsByQueryWiql(queryModel: QueryModel, project: string, includeResultDetails?: boolean, includeIterationDetails?: boolean, skip?: number, top?: number): Promise<TestCaseResult[]>

Параметры

queryModel
QueryModel
project

string

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

includeResultDetails

boolean

includeIterationDetails

boolean

skip

number

top

number

Возвращает

Promise<TestCaseResult[]>

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

Возвращает

getTestResultsSettings(string, TestResultsSettingsType)

Получение данных TestResultsSettings

function getTestResultsSettings(project: string, settingsType?: TestResultsSettingsType): Promise<TestResultsSettings>

Параметры

project

string

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

Возвращает

getTestResultWorkItemsById(string, number, number)

function getTestResultWorkItemsById(project: string, runId: number, testCaseResultId: number): Promise<WorkItemReference[]>

Параметры

project

string

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

runId

number

testCaseResultId

number

Возвращает

Promise<WorkItemReference[]>

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, boolean)

function getTestRunById(project: string, runId: number, includeDetails?: boolean, includeTags?: boolean): Promise<TestRun>

Параметры

project

string

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

runId

number

includeDetails

boolean

includeTags

boolean

Возвращает

Promise<TestRun>

getTestRunCodeCoverage(string, number, number)

function getTestRunCodeCoverage(project: string, runId: number, flags: number): Promise<TestRunCoverage[]>

Параметры

project

string

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

runId

number

flags

number

Возвращает

Promise<TestRunCoverage[]>

getTestRunLogs(string, number, TestLogType, string, string, boolean, number, String)

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

function getTestRunLogs(project: string, runId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

Параметры

project

string

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

runId

number

Идентификатор тестового запуска

type
TestLogType

тип вложений для получения

directoryPath

string

Путь к каталогу, для которого требуются вложения

fileNamePrefix

string

Префикс имени файла для фильтрации списка вложений

fetchMetaData

boolean

Значение по умолчанию равно false, если требуются метаданные

top

number

Количество ссылок на вложения для возврата

continuationToken

String

Заголовок для передачи продолженияToken

Возвращает

Promise<PagedList<TestLog>>

getTestRunLogStoreAttachmentContent(string, number, string)

Возвращает вложение с указанным именем файла для указанного runId из LogStore.

function getTestRunLogStoreAttachmentContent(project: string, runId: number, filename: string): Promise<ArrayBuffer>

Параметры

project

string

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

runId

number

Тестовый идентификатор runId

filename

string

Имя файла вложения

Возвращает

Promise<ArrayBuffer>

getTestRunLogStoreAttachments(string, number)

Возвращает список вложений для указанного runId из LogStore.

function getTestRunLogStoreAttachments(project: string, runId: number): Promise<TestLogStoreAttachment[]>

Параметры

project

string

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

runId

number

Тестовый идентификатор runId

Возвращает

getTestRunLogStoreAttachmentZip(string, number, string)

Возвращает вложение с указанным именем файла для указанного runId из LogStore.

function getTestRunLogStoreAttachmentZip(project: string, runId: number, filename: string): Promise<ArrayBuffer>

Параметры

project

string

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

runId

number

Тестовый идентификатор runId

filename

string

Имя файла вложения

Возвращает

Promise<ArrayBuffer>

getTestRunMessageLogs(string, number)

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

function getTestRunMessageLogs(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

owner

string

tmiRunId

string

planId

number

includeRunDetails

boolean

automated

boolean

skip

number

top

number

Возвращает

Promise<TestRun[]>

getTestRunsBySessionId(string, number)

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

function getTestRunsBySessionId(project: string, sessionId: number): Promise<number[]>

Параметры

project

string

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

sessionId

number

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

Возвращает

Promise<number[]>

getTestRunStatistics(string, number)

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

function getTestRunStatistics(project: string, runId: number): Promise<TestRunStatistic>

Параметры

project

string

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

runId

number

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

Возвращает

Promise<TestRunStatistic>

getTestRunSummaryByOutcome(string, number)

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

function getTestRunSummaryByOutcome(project: string, runId: number): Promise<TestRunStatistic>

Параметры

project

string

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

runId

number

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

Возвращает

Promise<TestRunStatistic>

getTestSession(string, number)

Извлекает объект метаданных TestResultsSession в хранилище данных TCM

function getTestSession(project: string, buildId: number): Promise<TestResultsSession[]>

Параметры

project

string

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

buildId

number

Возвращает

Promise<TestResultsSession[]>

getTestSessionLayout(string, string)

Извлекает объект Layout TestResultsSession в хранилище данных TCM

function getTestSessionLayout(project: string, sessionId: string): Promise<any[]>

Параметры

project

string

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

sessionId

string

Возвращает

Promise<any[]>

getTestSessionLayoutBySessionId(string, number)

Извлекает объект Layout TestResultsSession в хранилище данных TCM

function getTestSessionLayoutBySessionId(project: string, sessionId: number): Promise<any[]>

Параметры

project

string

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

sessionId

number

Получение объекта сеанса.

Возвращает

Promise<any[]>

getTestSessionResults(string, number, ResultDetails, number, number, TestOutcome[], boolean)

function getTestSessionResults(project: string, runId: number, detailsToInclude?: ResultDetails, skip?: number, top?: number, outcomes?: TestOutcome[], newTestsOnly?: boolean): Promise<TestCaseResult[]>

Параметры

project

string

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

runId

number

detailsToInclude
ResultDetails
skip

number

top

number

outcomes

TestOutcome[]

newTestsOnly

boolean

Возвращает

Promise<TestCaseResult[]>

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>

getTestSubResultLogs(string, number, number, number, TestLogType, string, string, boolean, number, String)

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

function getTestSubResultLogs(project: string, runId: number, resultId: number, subResultId: number, type: TestLogType, directoryPath?: string, fileNamePrefix?: string, fetchMetaData?: boolean, top?: number, continuationToken?: String): Promise<PagedList<TestLog>>

Параметры

project

string

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

runId

number

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

resultId

number

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

subResultId

number

Идентификатор тестового подресульта

type
TestLogType

тип вложений для получения

directoryPath

string

Путь к каталогу для получения вложения

fileNamePrefix

string

Префикс имени файла для фильтрации списка вложений

fetchMetaData

boolean

Значение по умолчанию равно false, если требуются метаданные

top

number

Количество ссылок на вложения для возврата

continuationToken

String

Заголовок для передачи продолженияToken

Возвращает

Promise<PagedList<TestLog>>

getTestTagsForBuild(string, number)

Получение всех тегов в сборке.

function getTestTagsForBuild(project: string, buildId: number): Promise<TestTag[]>

Параметры

project

string

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

buildId

number

Идентификатор сборки

Возвращает

Promise<TestTag[]>

getTestTagsForRelease(string, number, number)

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

function getTestTagsForRelease(project: string, releaseId: number, releaseEnvId: number): Promise<TestTag[]>

Параметры

project

string

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

releaseId

number

Идентификатор выпуска

releaseEnvId

number

Идентификатор среды выпуска

Возвращает

Promise<TestTag[]>

getTestTagSummaryForBuild(string, number)

Получение всех тегов в сборке.

function getTestTagSummaryForBuild(project: string, buildId: number): Promise<TestTagSummary>

Параметры

project

string

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

buildId

number

Идентификатор сборки

Возвращает

Promise<TestTagSummary>

getTestTagSummaryForRelease(string, number, number)

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

function getTestTagSummaryForRelease(project: string, releaseId: number, releaseEnvId: number): Promise<TestTagSummary>

Параметры

project

string

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

releaseId

number

Идентификатор выпуска

releaseEnvId

number

Идентификатор среды выпуска

Возвращает

Promise<TestTagSummary>

getTestWeightedScoreByBuild(string, number, boolean, boolean)

function getTestWeightedScoreByBuild(project: string, buildId: number, includeAllOutcomes?: boolean, onlyFlakyResults?: boolean): Promise<TestCaseResult[]>

Параметры

project

string

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

buildId

number

includeAllOutcomes

boolean

onlyFlakyResults

boolean

Возвращает

Promise<TestCaseResult[]>

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, ResultMetaDataDetails)

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

function queryTestResultsMetaData(testCaseReferenceIds: string[], project: string, detailsToInclude?: ResultMetaDataDetails): Promise<TestResultMetaData[]>

Параметры

testCaseReferenceIds

string[]

Идентификаторы TestCaseReference для запроса результата теста, разделенные запятыми, список допустимых идентификаторов (ограничение нет. идентификаторов 200).

project

string

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

detailsToInclude
ResultMetaDataDetails

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

Возвращает

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

Возвращает

queryTestResultsReportForPipeline(string, number, string, string, string, boolean)

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

function queryTestResultsReportForPipeline(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, includeFailureDetails?: boolean): Promise<TestResultSummary>

Параметры

project

string

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

pipelineId

number

Идентификатор конвейера. Это совпадает с идентификатором сборки.

stageName

string

Имя этапа. Максимальная поддерживаемая длина имени — 256 символов.

phaseName

string

Имя этапа. Максимальная поддерживаемая длина имени — 256 символов.

jobName

string

Матрица в YAML создает копии задания с различными входными данными в матрице. JobName — это имя входных данных. Максимальная поддерживаемая длина имени — 256 символов.

includeFailureDetails

boolean

Если значение true возвращает аналитические сведения о сбоях

Возвращает

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)

Результаты теста запросов WorkItems на основе фильтра

function queryTestResultWorkItems(project: string, workItemCategory: string, automatedTestName?: string, testCaseId?: number, maxCompleteDate?: Date, days?: number, workItemCount?: number): Promise<WorkItemReference[]>

Параметры

project

string

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

workItemCategory

string

может принимать значения Microsoft.BugCategory или all(для получения всех рабочих элементов)

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, TestRunSortOrderType, 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, sortOrder?: TestRunSortOrderType, continuationToken?: string): Promise<PagedList<TestRun>>

Параметры

project

string

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

minLastUpdatedDate

Date

Минимальная дата последнего изменения запуска (обязательный).

maxLastUpdatedDate

Date

Максимальная дата последнего изменения выполнения запроса (обязательно, разница между минимальной и максимальной датой может быть максимум 7 дней).

state
TestRunState

Текущее состояние запросов к запускам.

planIds

number[]

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

isAutomated

boolean

Тип автоматизации запуска, запрашиваемого.

publishContext
TestRunPublishContext

PublishContext для запросов к запускам.

buildIds

number[]

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

buildDefIds

number[]

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

branchName

string

Имя исходной ветви запуска, запрашиваемой.

releaseIds

number[]

Идентификаторы выпуска запуска для запроса, разделенные запятыми, разделенный списком допустимых идентификаторов.

releaseDefIds

number[]

Идентификаторы определения выпуска для запросов к запускам, разделенные запятыми, разделенный списком допустимых идентификаторов.

releaseEnvIds

number[]

Идентификаторы среды выпуска для запросов к запускам, разделенные запятыми, разделенный списком допустимых идентификаторов.

releaseEnvDefIds

number[]

Идентификаторы определения среды выпуска для запрашиваемых запусков, разделенные запятыми, разделенный списком допустимых идентификаторов.

runTitle

string

Заголовок запуска запуска для запроса.

top

number

Количество запросов к выполнению. Ограничение равно 100

sortOrder
TestRunSortOrderType

Сортировка по lastUpdated для тестовых запусков.

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[]

Возвращает

testLogStoreEndpointDetailsForBuild(string, number, TestLogStoreOperationType)

Создание и получение URI sas контейнера сборки

function testLogStoreEndpointDetailsForBuild(project: string, buildId: number, testLogStoreOperationType: TestLogStoreOperationType): Promise<TestLogStoreEndpointDetails>

Параметры

project

string

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

buildId

number

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

testLogStoreOperationType
TestLogStoreOperationType

Тип операции для выполнения с помощью URI sas

Возвращает

testLogStoreEndpointDetailsForResult(string, number, number, number, string, TestLogType)

Создание пустого файла для результата и получение URI Sas для файла

function testLogStoreEndpointDetailsForResult(project: string, runId: number, resultId: number, subResultId: number, filePath: string, type: TestLogType): Promise<TestLogStoreEndpointDetails>

Параметры

project

string

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

runId

number

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

resultId

number

Идентификатор результатов теста, содержащих вложенный результат

subResultId

number

Идентификатор тестового вложенного результата, uri файла sas которого необходим

filePath

string

путь к файлу внутри вложенного результата, для которого необходим URI sas

type
TestLogType

Тип файла для скачивания

Возвращает

testLogStoreEndpointDetailsForRun(string, number, TestLogStoreOperationType, string, TestLogType)

Создание пустого файла для запуска и получения URI Sas для файла

function testLogStoreEndpointDetailsForRun(project: string, runId: number, testLogStoreOperationType: TestLogStoreOperationType, filePath?: string, type?: TestLogType): Promise<TestLogStoreEndpointDetails>

Параметры

project

string

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

runId

number

Идентификатор выполнения для получения сведений о конечной точке

testLogStoreOperationType
TestLogStoreOperationType

Тип операции для выполнения с помощью URI sas

filePath

string

Путь к файлу для создания пустого файла

type
TestLogType

Значение по умолчанию — GeneralAttachment, тип пустого файла для создания

Возвращает

testResultsGroupDetails(string, number, string, string, string, boolean, boolean)

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

function testResultsGroupDetails(project: string, pipelineId: number, stageName?: string, phaseName?: string, jobName?: string, shouldIncludeFailedAndAbortedResults?: boolean, queryGroupSummaryForInProgress?: boolean): Promise<TestResultsDetails>

Параметры

project

string

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

pipelineId

number

Идентификатор конвейера. Это совпадает с идентификатором сборки.

stageName

string

Имя этапа. Максимальная поддерживаемая длина имени — 256 символов.

phaseName

string

Имя этапа. Максимальная поддерживаемая длина имени — 256 символов.

jobName

string

Матрица в YAML создает копии задания с различными входными данными в матрице. JobName — это имя входных данных. Максимальная поддерживаемая длина имени — 256 символов.

shouldIncludeFailedAndAbortedResults

boolean

Если задано значение true, он вернет идентификаторы неудачных и прерванных результатов для каждой тестовой группы

queryGroupSummaryForInProgress

boolean

Если значение true, оно также вычисляет сводку для выполнения InProgress.

Возвращает

updateCodeCoverageSummary(string, number, CodeCoverageData)

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

function updateCodeCoverageSummary(project: string, buildId: number, coverageData?: CodeCoverageData): Promise<void>

Параметры

project

string

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

buildId

number

coverageData
CodeCoverageData

Возвращает

Promise<void>

updateCustomField(CustomTestFieldUpdateDefinition, string)

Возвращает сведения о настраиваемом поле теста, которое обновляется.

function updateCustomField(updateCustomTestField: CustomTestFieldUpdateDefinition, project: string): Promise<CustomTestFieldDefinition>

Параметры

updateCustomTestField
CustomTestFieldUpdateDefinition

Настраиваемое поле теста, которое необходимо обновить.

project

string

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

Возвращает

updatePipelinesTestSettings(TestResultsUpdateSettings, string)

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

function updatePipelinesTestSettings(testResultsUpdateSettings: TestResultsUpdateSettings, project: string): Promise<TestResultsSettings>

Параметры

testResultsUpdateSettings
TestResultsUpdateSettings
project

string

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

Возвращает

updateTestResults(TestCaseResult[], string, number)

function updateTestResults(results: TestCaseResult[], project: string, runId: number): Promise<TestCaseResult[]>

Параметры

results

TestCaseResult[]

project

string

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

runId

number

Возвращает

Promise<TestCaseResult[]>

updateTestResultsMetaData(TestResultMetaDataUpdateInput, string, number)

Обновление свойств метаданных результатов теста

function updateTestResultsMetaData(testResultMetaDataUpdateInput: TestResultMetaDataUpdateInput, project: string, testCaseReferenceId: number): Promise<TestResultMetaData>

Параметры

testResultMetaDataUpdateInput
TestResultMetaDataUpdateInput

TestResultMetaData обновить ввод TestResultMetaDataUpdateInput

project

string

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

testCaseReferenceId

number

Идентификатор TestCaseReference для обновления результата теста.

Возвращает

updateTestResultsToTestRunSession(TestCaseResult[], string, number)

Создает объекты TestResultsMRX в хранилище данных TCM для существующих результатов теста

function updateTestResultsToTestRunSession(results: TestCaseResult[], project: string, runId: number): Promise<number[]>

Параметры

results

TestCaseResult[]

Объект результатов с только свойствами MRX и существующими свойствами testResultId

project

string

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

runId

number

RunId тестового запуска

Возвращает

Promise<number[]>

updateTestRun(RunUpdateModel, string, number)

function updateTestRun(runUpdateModel: RunUpdateModel, project: string, runId: number): Promise<TestRun>

Параметры

runUpdateModel
RunUpdateModel
project

string

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

runId

number

Возвращает

Promise<TestRun>

updateTestRunsBySessionId(TestSessionTestRun, string, number)

Обновление тестов, связанных с сеансом

function updateTestRunsBySessionId(testRunIds: TestSessionTestRun, project: string, sessionId: number): Promise<number[]>

Параметры

testRunIds
TestSessionTestRun
project

string

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

sessionId

number

Идентификатор сеанса TestResults для обновления тестовых запусков.

Возвращает

Promise<number[]>

updateTestRunTags(TestTagsUpdateModel, string, number)

Обновление тегов выполнения, теги можно добавить и удалить

function updateTestRunTags(testTagsUpdateModel: TestTagsUpdateModel, project: string, runId: number): Promise<TestTag[]>

Параметры

testTagsUpdateModel
TestTagsUpdateModel

TestTagsUpdateModel

project

string

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

runId

number

RunId запуска

Возвращает

Promise<TestTag[]>

updateTestSession(TestResultsSession, string, number)

Обновляет объект тестового сеанса, связанный с идентификатором сеанса

function updateTestSession(session: TestResultsSession, project: string, sessionId: number): Promise<number>

Параметры

session
TestResultsSession

Обновление объекта Session

project

string

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

sessionId

number

Идентификатор сеанса TestResults для обновления объекта сеанса Test.

Возвращает

Promise<number>