通过

Runs - Query

  • 参考
服务:
Test
API 版本:
7.1

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

GET https://dev.azure.com/{organization}/{project}/_apis/test/runs?minLastUpdatedDate={minLastUpdatedDate}&maxLastUpdatedDate={maxLastUpdatedDate}&api-version=7.1
具有可选参数: 
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

URI 参数

名称 在 必需 类型 说明
organization
 path True

string

Azure DevOps 组织的名称。
project
 path True

string

项目 ID 或项目名称
api-version
 query True

string

要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 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

类型: oauth2
流向: accessCode
授权 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 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

作用域

名称 说明
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

Object

BuildConfiguration 详细信息。

名称 类型 说明
branchName

string

为其生成生成的分支名称。
buildDefinitionId

integer (int32)

用于生成的 BuildDefinitionId。
buildSystem

string

生成系统。
creationDate

string (date-time)

生成创建日期。
flavor

string

生成风格（例如生成/发布）。
id

integer (int32)

BuildConfiguration ID。
number

string

内部版本号。
platform

string

BuildConfiguration 平台。
project

ShallowReference

与此 BuildConfiguration 关联的项目。
repositoryGuid

string

生成的存储库 Guid。
repositoryType

string

存储库类型（例如TFSGit。
sourceVersion

string

触发了生成的源版本（/第一次提交）。
targetBranchName

string

Target BranchName。
uri

string

生成 URI。

CustomTestField

Object

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

名称 类型 说明
fieldName

string

字段名称。
value

object

字段值。

DtlEnvironmentDetails

Object

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

名称 类型 说明
csmContent

string

csmParameters

string

subscriptionName

string

IdentityRef

Object
名称 类型 说明
_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

Object

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

名称 类型 说明
attempt

integer (int32)

作业的尝试次数
jobName

string

YAML 中的矩阵生成具有不同输入的作业副本。 JobName 是这些输入的名称。 名称支持的最大长度为 256 个字符。

PhaseReference

Object

管道中的阶段

名称 类型 说明
attempt

integer (int32)

阶段的尝试次数
phaseName

string

阶段的名称。 名称支持的最大长度为 256 个字符。

PipelineReference

Object

管道参考

名称 类型 说明
jobReference

JobReference

作业引用
phaseReference

PhaseReference

阶段的参考。
pipelineId

integer (int32)

与此管道实例相关的管道的引用。
stageReference

StageReference

阶段的参考。
Object

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

名称 类型 说明
links

object

链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读链接。

ReleaseReference

Object

对发布的引用。

名称 类型 说明
attempt

integer (int32)

发布尝试次数。
creationDate

string (date-time)

发布日期（UTC）。
definitionId

integer (int32)

发布定义 ID。
environmentCreationDate

string (date-time)

环境创建日期（UTC）。
environmentDefinitionId

integer (int32)

发布环境定义 ID。
environmentDefinitionName

string

发布环境定义名称。
environmentId

integer (int32)

发布环境 ID。
environmentName

string

发布环境名称。
id

integer (int32)

发布 ID。
name

string

发布名称。

ResultMetadata

枚举

给定结果/计数的 ResultMetadata。

值 说明
flaky

Flaky 元数据
rerun

重新运行元数据

RunFilter

Object

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

名称 类型 说明
sourceFilter

string

测试用例源的筛选器（测试容器）
testCaseFilter

string

测试用例的筛选器

RunStatistic

Object

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

名称 类型 说明
count

integer (int32)

给定结果的测试结果计数。
outcome

string

测试结果结果
resolutionState

TestResolutionState

测试运行解析状态。
resultMetadata

ResultMetadata

给定结果/计数的 ResultMetadata。
state

string

测试运行的状态

ShallowReference

Object

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

名称 类型 说明
id

string

资源的 ID
name

string

链接资源的名称（定义名称、控制器名称等）
url

string

指向资源的完整 http 链接

StageReference

Object

管道中的阶段

名称 类型 说明
attempt

integer (int32)

尝试阶段数
stageName

string

阶段的名称。 名称支持的最大长度为 256 个字符。

TestEnvironment

Object

测试环境详细信息。

名称 类型 说明
environmentId

string (uuid)

测试环境 ID。
environmentName

string

测试环境名称。

TestResolutionState

Object

测试解析状态详细信息。

名称 类型 说明
id

integer (int32)

测试解析状态 ID。
name

string

测试解析状态名称。
project

ShallowReference

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

TestRun

Object

测试运行详细信息。

名称 类型 说明
build

ShallowReference

与此测试运行关联的生成。
buildConfiguration

BuildConfiguration

生成与此测试运行关联的配置详细信息。
comment

string

分析运行的人员输入的注释。
completedDate

string (date-time)

已完成的运行日期时间。
controller

string

测试运行控制器。
createdDate

string (date-time)

测试运行 CreatedDate。
customFields

CustomTestField[]

TestRun 的自定义字段列表。
dropLocation

string

删除测试运行的位置。
dtlAutEnvironment

ShallowReference

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

ShallowReference

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

DtlEnvironmentDetails

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

string (date-time)

测试运行的截止日期和时间。
errorMessage

string

与运行关联的错误消息。
filter

RunFilter

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

integer (int32)

测试运行的 ID。
incompleteTests

integer (int32)

不完整的测试数。
isAutomated

boolean

如果测试运行是自动化的，则为 true;否则为 false。
iteration

string

运行所属的迭代。
lastUpdatedBy

IdentityRef

上次更新测试运行的团队基础 ID。
lastUpdatedDate

string (date-time)

上次更新时间和时间
name

string

测试运行的名称。
notApplicableTests

integer (int32)

不适用的测试数。
owner

IdentityRef

运行所有者的 Team Foundation ID。
passedTests

integer (int32)

运行中通过的测试数
phase

string

testRun 的阶段/状态。
pipelineReference

PipelineReference

此测试运行所属的管道的引用。
plan

ShallowReference

与此测试运行关联的测试计划。
postProcessState

string

处理后状态。
project

ShallowReference

与此运行关联的项目。
release

ReleaseReference

测试运行的发布参考。
releaseEnvironmentUri

string

TestRun 的发布环境 URI。
releaseUri

string

TestRun 的发布 URI。
revision

integer (int32)

runStatistics

RunStatistic[]

按结果运行。
startedDate

string (date-time)

运行的开始日期时间。
state

string

运行的状态。 类型 TestRunState 有效状态 - 未指定、NotStarted、InProgress、Completed、Waiting、Aborted、NeedsInvestigation
substate

TestRunSubstate

TestRun Substate。
tags

TestTag[]

随此测试运行一起附加的标记。
testEnvironment

TestEnvironment

与运行关联的测试环境。
testMessageLogId

integer (int32)

testSettings

ShallowReference

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

integer (int32)

运行中的测试总数
unanalyzedTests

integer (int32)

运行中失败的测试数。
url

string

测试运行的 URL
webAccessUrl

string

TestRun 的 Web 访问 URL。

TestRunPublishContext

枚举

要查询的运行的 PublishContext。

值 说明
all

针对任何上下文发布运行。
build

针对生成上下文发布运行。
release

针对发布上下文发布运行。

TestRunState

枚举
值 说明
aborted

运行已停止，剩余测试已中止
completed

所有测试都已完成或已跳过。
inProgress

测试正在运行。
needsInvestigation

运行需要调查，因为测试点失败，这是一个旧状态，不应再使用
notStarted

仍在创建运行。 尚未开始测试。
unspecified

仅在更新期间使用以保留现有值。
waiting

运行当前正在初始化这是一个旧状态，不应再使用

TestRunSubstate

枚举

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

值 说明
abortedBySystem

由系统中止时运行状态。
analyzed

分析后运行状态。
canceledByUser

创建环境时运行状态。
cancellationInProgress

取消正在进行时运行状态。
creatingEnvironment

创建环境时运行状态。
none

使用 noState 运行。
pendingAnalysis

挂起分析时运行状态。
runningTests

运行测试时运行状态。
timedOut

运行时运行状态为 timedOut。

TestTag

Object

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

名称 类型 说明
name

string

标记的名称，字母数字值小于 30 个字符