Runs - Get Test Run By Id
Получение тестового запуска по его идентификатору.
GET https://dev.azure.com/{organization}/{project}/_apis/test/runs/{runId}?api-version=7.1-preview.3
GET https://dev.azure.com/{organization}/{project}/_apis/test/runs/{runId}?includeDetails={includeDetails}&api-version=7.1-preview.3
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
organization
|
path | True |
string |
Название организации Azure DevOps. |
project
|
path | True |
string |
Идентификатор проекта или имя проекта |
run
|
path | True |
integer int32 |
Идентификатор получаемого запуска. |
api-version
|
query | True |
string |
Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.3. |
include
|
query |
boolean |
Значение по умолчанию — true. Он содержит такие сведения, как статистика выполнения, выпуск, сборка, тестовая среда, состояние после процесса и многое другое. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
успешная операция |
Безопасность
oauth2
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL:
https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
Scopes
Имя | Описание |
---|---|
vso.test | Предоставляет возможность считывать планы тестирования, варианты, результаты и другие артефакты, связанные с управлением тестированием. |
Примеры
Sample Request
GET https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/runs/1?api-version=7.1-preview.3
Sample Response
{
"id": 1,
"name": "sprint1 (Manual)",
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Runs/1",
"isAutomated": false,
"iteration": "Fabrikam-Fiber-TFVC\\Release 1\\Sprint 1",
"owner": {
"id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
"displayName": "Fabrikam Fiber",
"uniqueName": "fabrikamfiber1@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
},
"project": {
"id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
"name": "Fabrikam-Fiber-TFVC",
"url": "https://dev.azure.com/fabrikam/_apis/projects/Fabrikam-Fiber-TFVC"
},
"startedDate": "2014-05-04T12:50:33.17Z",
"completedDate": "2014-05-04T12:50:31.953Z",
"state": "Completed",
"plan": {
"id": "1",
"name": "sprint1",
"url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1"
},
"postProcessState": "Complete",
"totalTests": 1,
"passedTests": 1,
"createdDate": "2014-05-04T12:50:31.38Z",
"lastUpdatedDate": "2014-05-04T12:50:31.953Z",
"lastUpdatedBy": {
"id": "e5a5f7f8-6507-4c34-b397-6c4818e002f4",
"displayName": "Fabrikam Fiber",
"uniqueName": "fabrikamfiber1@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e5a5f7f8-6507-4c34-b397-6c4818e002f4",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=e5a5f7f8-6507-4c34-b397-6c4818e002f4"
},
"revision": 3
}
Определения
Имя | Описание |
---|---|
Build |
BuildConfiguration Details. |
Custom |
Сведения о настраиваемом поле. Allowed Key : Value pairs - ( AttemptId: int value, IsTestResultFlaky: bool) |
Dtl |
Это временный класс для предоставления сведений о среде тестового запуска. |
Identity |
|
Job |
Задание в конвейере. Это связано с матрицированием в YAML. |
Phase |
Этап в конвейере |
Pipeline |
Справочник по конвейеру |
Reference |
Класс, представляющий коллекцию ссылок REST. |
Release |
Ссылка на выпуск. |
Result |
ResultMetadata для заданного результата или счетчика. |
Run |
Этот класс используется для предоставления фильтров, используемых для обнаружения. |
Run |
Статистика тестового выполнения для каждого результата. |
Shallow |
Абстрактная ссылка на какой-то другой ресурс. Этот класс используется для предоставления контрактам данных сборки единообразным способом ссылки на другие ресурсы таким образом, чтобы обеспечить простой обход по ссылкам. |
Stage |
Этап в конвейере |
Test |
Сведения о тестовой среде. |
Test |
Сведения о состоянии разрешения теста. |
Test |
Сведения о тестовом запуске. |
Test |
Типы вложенных состояний для тестового запуска. |
Test |
Тег, присоединенный к выполнению или результату. |
BuildConfiguration
BuildConfiguration Details.
Имя | Тип | Описание |
---|---|---|
branchName |
string |
Имя ветви, для которой создается сборка. |
buildDefinitionId |
integer |
BuildDefinitionId для сборки. |
buildSystem |
string |
Система сборки. |
creationDate |
string |
Дата создания сборки. |
flavor |
string |
Вариант сборки (например, сборка или выпуск). |
id |
integer |
BuildConfiguration Id. |
number |
string |
Номер сборки. |
platform |
string |
BuildConfiguration Platform. |
project |
Проект, связанный с этой buildConfiguration. |
|
repositoryGuid |
string |
Guid репозитория для сборки. |
repositoryType |
string |
Тип репозитория (например, TFSGit). |
sourceVersion |
string |
Была активирована исходная версия (/первая фиксация) для сборки. |
targetBranchName |
string |
Target BranchName. |
uri |
string |
URI сборки. |
CustomTestField
Сведения о настраиваемом поле. Allowed Key : Value pairs - ( AttemptId: int value, IsTestResultFlaky: bool)
Имя | Тип | Описание |
---|---|---|
fieldName |
string |
имя поля; |
value |
object |
Значение поля. |
DtlEnvironmentDetails
Это временный класс для предоставления сведений о среде тестового запуска.
Имя | Тип | Описание |
---|---|---|
csmContent |
string |
|
csmParameters |
string |
|
subscriptionName |
string |
IdentityRef
Имя | Тип | Описание |
---|---|---|
_links |
Это поле содержит ноль или более интересных ссылок на тему графа. Эти ссылки можно вызвать для получения дополнительных связей или более подробных сведений об этой теме графа. |
|
descriptor |
string |
Дескриптор является основным способом ссылки на субъект графа во время работы системы. Это поле однозначно идентифицирует одну и ту же тему графа как в учетных записях, так и в организациях. |
directoryAlias |
string |
Нерекомендуемое — можно получить запрос пользователя Graph, на который ссылается запись self словаря IdentityRef _links. |
displayName |
string |
Это неуникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в поставщике источника. |
id |
string |
|
imageUrl |
string |
Не рекомендуется — доступно в записи "аватар" словаря IdentityRef "_links" |
inactive |
boolean |
Нерекомендуемое — можно получить запрос к состоянию членства Graph, на которое ссылается запись "membershipState" словаря GraphUser "_links". |
isAadIdentity |
boolean |
Нерекомендуемый — может быть выведен из типа субъекта дескриптора (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
isContainer |
boolean |
Нерекомендуемый — может быть выведен из типа субъекта дескриптора (Descriptor.IsGroupType) |
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
Не рекомендуется — не используется в большинстве уже существовающих реализаций ToIdentityRef |
uniqueName |
string |
Не рекомендуется использовать вместо него домен+principalName. |
url |
string |
Этот URL-адрес представляет собой полный маршрут к исходному ресурсу этого субъекта графа. |
JobReference
Задание в конвейере. Это связано с матрицированием в YAML.
Имя | Тип | Описание |
---|---|---|
attempt |
integer |
Номер попытки задания |
jobName |
string |
При матрице в YAML создаются копии задания с разными входными данными в матрице. JobName — это имя этих входных данных. Максимальная поддерживаемая длина имени — 256 символов. |
PhaseReference
Этап в конвейере
Имя | Тип | Описание |
---|---|---|
attempt |
integer |
Номер попытки этапа |
phaseName |
string |
Имя этапа. Максимальная поддерживаемая длина имени — 256 символов. |
PipelineReference
Справочник по конвейеру
Имя | Тип | Описание |
---|---|---|
jobReference |
Справочник по заданию |
|
phaseReference |
Ссылка на этап. |
|
pipelineId |
integer |
Ссылка на конвейер, с которым связан этот экземпляр конвейера. |
stageReference |
Ссылка на этап. |
ReferenceLinks
Класс, представляющий коллекцию ссылок REST.
Имя | Тип | Описание |
---|---|---|
links |
object |
Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения. |
ReleaseReference
Ссылка на выпуск.
Имя | Тип | Описание |
---|---|---|
attempt |
integer |
Число попыток выпуска. |
creationDate |
string |
Дата создания выпуска (UTC). |
definitionId |
integer |
Идентификатор определения выпуска. |
environmentCreationDate |
string |
Дата создания среды (UTC). |
environmentDefinitionId |
integer |
Идентификатор определения среды выпуска. |
environmentDefinitionName |
string |
Имя определения среды выпуска. |
environmentId |
integer |
Идентификатор среды выпуска. |
environmentName |
string |
Имя среды выпуска. |
id |
integer |
Идентификатор выпуска. |
name |
string |
Имя выпуска. |
ResultMetadata
ResultMetadata для заданного результата или счетчика.
Имя | Тип | Описание |
---|---|---|
flaky |
string |
Ненадежные метаданные |
rerun |
string |
Повторный запуск метаданных |
RunFilter
Этот класс используется для предоставления фильтров, используемых для обнаружения.
Имя | Тип | Описание |
---|---|---|
sourceFilter |
string |
фильтр для источников тестовых случаев (тестовые контейнеры) |
testCaseFilter |
string |
фильтр для тестовых случаев |
RunStatistic
Статистика тестового выполнения для каждого результата.
Имя | Тип | Описание |
---|---|---|
count |
integer |
Количество результатов теста для заданного результата. |
outcome |
string |
Результат теста |
resolutionState |
Состояние разрешения тестового запуска. |
|
resultMetadata |
ResultMetadata для заданного результата или счетчика. |
|
state |
string |
Состояние тестового запуска |
ShallowReference
Абстрактная ссылка на какой-то другой ресурс. Этот класс используется для предоставления контрактам данных сборки единообразным способом ссылки на другие ресурсы таким образом, чтобы обеспечить простой обход по ссылкам.
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор ресурса |
name |
string |
Имя связанного ресурса (имя определения, имя контроллера и т. д.) |
url |
string |
Полная ссылка HTTP на ресурс |
StageReference
Этап в конвейере
Имя | Тип | Описание |
---|---|---|
attempt |
integer |
Число попыток этапа |
stageName |
string |
Имя этапа. Максимальная поддерживаемая длина имени — 256 символов. |
TestEnvironment
Сведения о тестовой среде.
Имя | Тип | Описание |
---|---|---|
environmentId |
string |
Идентификатор тестовой среды. |
environmentName |
string |
Имя тестовой среды. |
TestResolutionState
Сведения о состоянии разрешения теста.
Имя | Тип | Описание |
---|---|---|
id |
integer |
Идентификатор состояния разрешения теста. |
name |
string |
Имя состояния разрешения теста. |
project |
Абстрактная ссылка на какой-то другой ресурс. Этот класс используется для предоставления контрактам данных сборки единообразного способа ссылки на другие ресурсы таким образом, чтобы обеспечить простой обход по ссылкам. |
TestRun
Сведения о тестовом запуске.
Имя | Тип | Описание |
---|---|---|
build |
Сборка, связанная с этим тестом. |
|
buildConfiguration |
Сведения о конфигурации сборки, связанные с этим тестом. |
|
comment |
string |
Комментарии, введенные теми, кто анализирует выполнение. |
completedDate |
string |
Дата завершения выполнения. |
controller |
string |
Контроллер тестового запуска. |
createdDate |
string |
Тестовое выполнение CreatedDate. |
customFields |
Список настраиваемых полей для TestRun. |
|
dropLocation |
string |
Удалить расположение для тестового запуска. |
dtlAutEnvironment |
Абстрактная ссылка на какой-то другой ресурс. Этот класс используется для предоставления контрактам данных сборки единообразным способом ссылки на другие ресурсы таким образом, чтобы обеспечить простой обход по ссылкам. |
|
dtlEnvironment |
Абстрактная ссылка на какой-то другой ресурс. Этот класс используется для предоставления контрактам данных сборки единообразным способом ссылки на другие ресурсы таким образом, чтобы обеспечить простой обход по ссылкам. |
|
dtlEnvironmentCreationDetails |
Это временный класс для предоставления сведений о среде тестового запуска. |
|
dueDate |
string |
Дата и время выполнения теста. |
errorMessage |
string |
Сообщение об ошибке, связанное с выполнением. |
filter |
Этот класс используется для предоставления фильтров, используемых для обнаружения. |
|
id |
integer |
Идентификатор тестового запуска. |
incompleteTests |
integer |
Количество неполных тестов. |
isAutomated |
boolean |
Значение true, если тестовый запуск выполняется автоматически, в противном случае — false. |
iteration |
string |
Итерация, которой принадлежит выполнение. |
lastUpdatedBy |
Team Foundation ID последнего обновленного тестового запуска. |
|
lastUpdatedDate |
string |
Дата и время последнего обновления |
name |
string |
Имя тестового запуска. |
notApplicableTests |
integer |
Число неприменимых тестов. |
owner |
Идентификатор Team Foundation владельца запусков. |
|
passedTests |
integer |
Количество пройденных тестов в ходе выполнения |
phase |
string |
Этап или состояние для testRun. |
pipelineReference |
Ссылка на конвейер, к которому относится этот тестовый запуск. |
|
plan |
План тестирования, связанный с этим тестом. |
|
postProcessState |
string |
Состояние после процесса. |
project |
Проект, связанный с этим выполнением. |
|
release |
Справочник по выпуску тестового запуска. |
|
releaseEnvironmentUri |
string |
URI среды выпуска для TestRun. |
releaseUri |
string |
URI выпуска для TestRun. |
revision |
integer |
|
runStatistics |
RunSummary по результату. |
|
startedDate |
string |
Дата начала выполнения. |
state |
string |
Состояние выполнения. Допустимые состояния Типа TestRunState — Unspecified , NotStarted, InProgress, Completed, Waiting, Aborted, NeedsInvestigation |
substate |
Подсостояние TestRun. |
|
tags |
Test |
Теги, присоединенные к этому тестовом выполнению. |
testEnvironment |
Тестовая среда, связанная с запуском. |
|
testMessageLogId |
integer |
|
testSettings |
Абстрактная ссылка на какой-то другой ресурс. Этот класс используется для предоставления контрактам данных сборки единообразным способом ссылки на другие ресурсы таким образом, чтобы обеспечить простой обход по ссылкам. |
|
totalTests |
integer |
Общее количество тестов в ходе выполнения |
unanalyzedTests |
integer |
Количество неудачных тестов в ходе выполнения. |
url |
string |
URL-адрес тестового запуска |
webAccessUrl |
string |
URL-адрес веб-доступа для TestRun. |
TestRunSubstate
Типы вложенных состояний для тестового запуска.
Имя | Тип | Описание |
---|---|---|
abortedBySystem |
string |
Состояние запуска, когда оно прервано системой. |
analyzed |
string |
Состояние выполнения после анализа. |
canceledByUser |
string |
Состояние выполнения при создании среды. |
cancellationInProgress |
string |
Состояние выполнения при выполнении отмены. |
creatingEnvironment |
string |
Состояние выполнения при создании среды. |
none |
string |
Запуск с noState. |
pendingAnalysis |
string |
Состояние выполнения при ожидании анализа. |
runningTests |
string |
Состояние выполнения во время выполнения тестов. |
timedOut |
string |
Состояние выполнения, если для выполнения установлено время ожидания. |
TestTag
Тег, присоединенный к выполнению или результату.
Имя | Тип | Описание |
---|---|---|
name |
string |
Имя тега, буквенно-цифровое значение менее 30 символов |