Runs - Query

Service:

Test

API Version:

7.1-preview.3

查询测试基于筛选器运行。 必填字段为 minLastUpdatedDate 和 maxLastUpdatedDate。

GET https://dev.azure.com/{organization}/{project}/_apis/test/runs?minLastUpdatedDate={minLastUpdatedDate}&maxLastUpdatedDate={maxLastUpdatedDate}&api-version=7.1-preview.3

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/test/runs?minLastUpdatedDate={minLastUpdatedDate}&maxLastUpdatedDate={maxLastUpdatedDate}&state={state}&planIds={planIds}&isAutomated={isAutomated}&publishContext={publishContext}&buildIds={buildIds}&buildDefIds={buildDefIds}&branchName={branchName}&releaseIds={releaseIds}&releaseDefIds={releaseDefIds}&releaseEnvIds={releaseEnvIds}&releaseEnvDefIds={releaseEnvDefIds}&runTitle={runTitle}&$top={$top}&continuationToken={continuationToken}&api-version=7.1-preview.3

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。 应将其设置为“7.1-preview.3”才能使用此版本的 API。
maxLastUpdatedDate	query	True	string date-time	要查询的最大上次修改运行日期 (必需，最小和最大日期之间的差值最长为 7 天) 。
minLastUpdatedDate	query	True	string date-time	要查询的最小上次修改日期 (必需) 。
$top	query		integer int32	要查询的运行数。 限制为 100
branchName	query		string	要查询的运行的源分支名称。
buildDefIds	query		string array (int32)	生成要查询的运行的定义 ID，以逗号分隔的有效 ID 列表 (id 限制为 10) 。
buildIds	query		string array (int32)	要查询的运行的生成 ID，以逗号分隔的有效 ID 列表 (id 限制为 10) 。
continuationToken	query		string	continuationToken 从上一批接收，对于第一批为 null。 如果用户从上一批) 接收，则不应 (或更改它。
isAutomated	query		boolean	要查询的运行的自动化类型。
planIds	query		string array (int32)	要查询的运行的计划 ID，有效 ID 的逗号分隔列表 (id 限制为 10) 。
publishContext	query		TestRunPublishContext	要查询的运行的 PublishContext。
releaseDefIds	query		string array (int32)	要查询的运行的发布定义 ID，以逗号分隔的有效 ID 列表 (id 限制编号 10) 。
releaseEnvDefIds	query		string array (int32)	发布要查询的运行的环境定义 ID，以逗号分隔的有效 ID 列表 (id 限制为 10) 。
releaseEnvIds	query		string array (int32)	要查询的运行的发布环境 ID，以逗号分隔的有效 ID 列表 (id 限制编号 10) 。
releaseIds	query		string array (int32)	要查询的运行的发布 ID，以逗号分隔的有效 ID 列表 (id 限制为 10) 。
runTitle	query		string	运行要查询的运行标题。
state	query		TestRunState	要查询的运行的当前状态。

响应

名称	类型	说明
200 OK	TestRun[]	成功的操作

安全性

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	授予读取测试计划、案例、结果和其他测试管理相关项目的能力。

定义

名称	说明
BuildConfiguration	BuildConfiguration 详细信息。
CustomTestField	自定义字段信息。 允许的键： 值对 - ( AttemptId： int 值， IsTestResultFlaky： bool)
DtlEnvironmentDetails	这是一个临时类，用于提供测试运行环境的详细信息。
IdentityRef
JobReference	管道中的作业。 这与 YAML 中的矩阵相关。
PhaseReference	管道中的阶段
PipelineReference	管道参考
ReferenceLinks	表示 REST 引用链接集合的类。
ReleaseReference	对发布的引用。
ResultMetadata	给定结果/计数的 ResultMetadata。
RunFilter	此类用于提供用于发现的筛选器
RunStatistic	每个结果的测试运行统计信息。
ShallowReference	对某些其他资源的抽象引用。 此类用于为生成数据协定提供一种统一的方式来引用其他资源，以便轻松遍历链接。
StageReference	管道中的阶段
TestEnvironment	测试环境详细信息。
TestResolutionState	测试解析状态详细信息。
TestRun	测试运行详细信息。
TestRunPublishContext	要查询的运行的 PublishContext。
TestRunState
TestRunSubstate	测试运行的子状态的类型。
TestTag	附加到运行或结果的标记。

BuildConfiguration

BuildConfiguration 详细信息。

名称	类型	说明
branchName	string	为其生成生成的分支名称。
buildDefinitionId	integer	BuildDefinitionId for build。
buildSystem	string	生成系统。
creationDate	string	生成创建日期。
flavor	string	生成风格 (例如生成/发布) 。
id	integer	BuildConfiguration ID。
number	string	Build 号。
platform	string	BuildConfiguration Platform。
project	ShallowReference	与此 BuildConfiguration 关联的项目。
repositoryGuid	string	生成的存储库 Guid。
repositoryType	string	存储库类型 (例如TFSGit) 。
sourceVersion	string	触发了生成的源版本 (/first 提交) 。
targetBranchName	string	Target BranchName。
uri	string	生成 URI。

CustomTestField

自定义字段信息。 允许的键： 值对 - ( AttemptId： int 值， IsTestResultFlaky： bool)

名称	类型	说明
fieldName	string	字段名称。
value	object	字段值。

DtlEnvironmentDetails

这是一个临时类，用于提供测试运行环境的详细信息。

名称	类型	说明
csmContent	string
csmParameters	string
subscriptionName	string

IdentityRef

名称	类型	说明
_links	ReferenceLinks	此字段包含零个或多个有关图形主题的有趣链接。 可以调用这些链接来获取有关此图主题的其他关系或更详细的信息。
descriptor	string	描述符是在系统运行时引用图形主题的主要方法。 此字段将唯一标识帐户和组织中的同一图形主题。
directoryAlias	string	已弃用 - 可通过查询 IdentityRef“_links”字典的“self”条目中引用的 Graph 用户来检索
displayName	string	这是图形主题的非唯一显示名称。 若要更改此字段，必须在源提供程序中更改其值。
id	string
imageUrl	string	已弃用 - 在 IdentityRef“_links”字典的“头像”条目中可用
inactive	boolean	已弃用 - 可通过查询 GraphUser“_links”字典的“membershipState”条目中引用的 Graph 成员身份状态来检索
isAadIdentity	boolean	已弃用 - 可以从描述符的主题类型推断 (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	已弃用 - 可以从描述符的主题类型推断 (描述符.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	已弃用 - 未在 ToIdentityRef 的大多数预先存在的实现中使用
uniqueName	string	已弃用 - 改用 Domain+PrincipalName
url	string	此 URL 是此图主题的源资源的完整路由。

JobReference

管道中的作业。 这与 YAML 中的矩阵相关。

名称	类型	说明
attempt	integer	作业的尝试次数
jobName	string	YAML 中的矩阵在矩阵中生成具有不同输入的作业的副本。 JobName 是这些输入的名称。 名称支持的最大长度为 256 个字符。

PhaseReference

管道中的阶段

名称	类型	说明
attempt	integer	阶段的尝试次数
phaseName	string	阶段的名称。 名称支持的最大长度为 256 个字符。

PipelineReference

管道参考

名称	类型	说明
jobReference	JobReference	作业的引用
phaseReference	PhaseReference	阶段的引用。
pipelineId	integer	与此管道实例相关的管道的引用。
stageReference	StageReference	阶段的引用。

ReferenceLinks

表示 REST 引用链接集合的类。

名称	类型	说明
links	object	链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读。

ReleaseReference

对发布的引用。

名称	类型	说明
attempt	integer	发布尝试次数。
creationDate	string	发行创建日期 (UTC) 。
definitionId	integer	发布定义 ID。
environmentCreationDate	string	环境创建日期 (UTC) 。
environmentDefinitionId	integer	发布环境定义 ID。
environmentDefinitionName	string	发布环境定义名称。
environmentId	integer	发布环境 ID。
environmentName	string	发布环境名称。
id	integer	发布 ID。
name	string	版本名称。

ResultMetadata

给定结果/计数的 ResultMetadata。

名称	类型	说明
flaky	string	不起的元数据
rerun	string	重新运行元数据

RunFilter

此类用于提供用于发现的筛选器

名称	类型	说明
sourceFilter	string	测试用例源的筛选器 (测试容器)
testCaseFilter	string	测试用例的筛选器

RunStatistic

每个结果的测试运行统计信息。

名称	类型	说明
count	integer	给定结果的测试结果计数。
outcome	string	测试结果结果
resolutionState	TestResolutionState	测试运行解析状态。
resultMetadata	ResultMetadata	给定结果/计数的 ResultMetadata。
state	string	测试运行的状态

ShallowReference

对某些其他资源的抽象引用。 此类用于为生成数据协定提供一种统一的方式来引用其他资源，以便轻松遍历链接。

名称	类型	说明
id	string	资源的 ID
name	string	链接资源的名称 (定义名称、控制器名称等)
url	string	指向资源的完整 http 链接

StageReference

管道中的阶段

名称	类型	说明
attempt	integer	阶段的尝试次数
stageName	string	阶段的名称。 名称支持的最大长度为 256 个字符。

TestEnvironment

测试环境详细信息。

名称	类型	说明
environmentId	string	测试环境 ID。
environmentName	string	测试环境名称。

TestResolutionState

测试解析状态详细信息。

名称	类型	说明
id	integer	测试解析状态 ID。
name	string	测试解析状态名称。
project	ShallowReference	对某些其他资源的抽象引用。 此类用于提供生成数据协定，使用统一的方式引用其他资源，以便轻松遍历链接。

TestRun

测试运行详细信息。

名称	类型	说明
build	ShallowReference	与此测试运行关联的生成。
buildConfiguration	BuildConfiguration	与此测试运行关联的生成配置详细信息。
comment	string	分析运行的人员输入的注释。
completedDate	string	已完成运行的日期时间。
controller	string	测试运行控制器。
createdDate	string	测试运行创建日期。
customFields	CustomTestField[]	TestRun 的自定义字段列表。
dropLocation	string	删除测试运行的位置。
dtlAutEnvironment	ShallowReference	对某些其他资源的抽象引用。 此类用于为生成数据协定提供一种统一的方式来引用其他资源，以便轻松遍历链接。
dtlEnvironment	ShallowReference	对某些其他资源的抽象引用。 此类用于为生成数据协定提供一种统一的方式来引用其他资源，以便轻松遍历链接。
dtlEnvironmentCreationDetails	DtlEnvironmentDetails	这是一个临时类，用于提供测试运行环境的详细信息。
dueDate	string	测试运行的截止日期和时间。
errorMessage	string	与运行关联的错误消息。
filter	RunFilter	此类用于提供用于发现的筛选器
id	integer	测试运行的 ID。
incompleteTests	integer	不完整测试的数目。
isAutomated	boolean	如果测试运行是自动的，则为 true;否则为 false。
iteration	string	运行所属的迭代。
lastUpdatedBy	IdentityRef	上次更新的测试运行的团队基础 ID。
lastUpdatedDate	string	上次更新时间
name	string	测试运行的名称。
notApplicableTests	integer	不适用测试的数目。
owner	IdentityRef	运行所有者的 Team Foundation ID。
passedTests	integer	运行中通过的测试数
phase	string	testRun 的阶段/状态。
pipelineReference	PipelineReference	此测试运行所属管道的引用。
plan	ShallowReference	与此测试运行关联的测试计划。
postProcessState	string	后期处理状态。
project	ShallowReference	与此运行关联的项目。
release	ReleaseReference	测试运行的发布参考。
releaseEnvironmentUri	string	TestRun 的发布环境 URI。
releaseUri	string	TestRun 的发布 URI。
revision	integer
runStatistics	RunStatistic[]	按结果排序的 RunSummary。
startedDate	string	运行的开始日期时间。
state	string	运行的状态。 类型 TestRunState 有效状态 - 未指定、NotStarted、InProgress、Completed、Waiting、Aborted、NeedsInvestigation
substate	TestRunSubstate	TestRun 子状态。
tags	TestTag[]	此测试运行附加的标记。
testEnvironment	TestEnvironment	与运行关联的测试环境。
testMessageLogId	integer
testSettings	ShallowReference	对某些其他资源的抽象引用。 此类用于为生成数据协定提供一种统一的方式来引用其他资源，以便轻松遍历链接。
totalTests	integer	运行中的测试总数
unanalyzedTests	integer	运行中失败的测试数。
url	string	测试运行的 URL
webAccessUrl	string	TestRun 的 Web 访问 URL。

TestRunPublishContext

要查询的运行的 PublishContext。

名称	类型	说明
all	string	针对任何上下文发布运行。
build	string	针对生成上下文发布运行。
release	string	针对发布上下文发布运行。

TestRunState

名称	类型	说明
aborted	string	运行已停止，剩余测试已中止
completed	string	所有测试都已完成或已跳过。
inProgress	string	测试正在运行。
needsInvestigation	string	由于测试点失败，运行需要调查 这是旧状态，不应再使用
notStarted	string	仍在创建运行。 尚未开始任何测试。
unspecified	string	仅在更新期间使用以保留现有值。
waiting	string	运行当前正在初始化 这是旧状态，不应再使用

TestRunSubstate

测试运行的子状态的类型。

名称	类型	说明
abortedBySystem	string	当系统中止时运行状态。
analyzed	string	分析后的运行状态。
canceledByUser	string	创建环境时运行状态。
cancellationInProgress	string	取消正在进行时运行状态。
creatingEnvironment	string	创建环境时运行状态。
none	string	使用 noState 运行。
pendingAnalysis	string	挂起分析时运行状态。
runningTests	string	运行测试时运行状态。
timedOut	string	运行具有 timedOut 时的运行状态。

TestTag

附加到运行或结果的标记。

名称	类型	说明
name	string	标记的名称，字母数字值小于 30 个字符