Runs - Create

参考

服务:: Test

API 版本:: 7.1

创建新的测试运行。

POST https://dev.azure.com/{organization}/{project}/_apis/test/runs?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。

请求正文

名称	类型	说明
automated	boolean	如果测试运行是自动化的，则为 true;否则为 false。默认情况下，它将为 false。
build	ShallowReference	对它所属的生成的抽象引用。
buildDropLocation	string	放置用于测试运行的生成的位置。
buildFlavor	string	用于测试运行的生成风格。（例如：发布、调试）
buildPlatform	string	用于测试运行的生成平台。（例如：x86、amd64）
buildReference	BuildConfiguration	测试运行的 BuildReference。
comment	string	分析运行的人员输入的注释。
completeDate	string	已完成的运行日期时间。
configurationIds	integer[] (int32)	与运行关联的测试配置的 ID。
controller	string	用于自动运行的测试控制器的名称。
customTestFields	CustomTestField[]	测试运行的其他属性。
dtlAutEnvironment	ShallowReference	对 DtlAutEnvironment 的抽象引用。
dtlTestEnvironment	ShallowReference	对 DtlTestEnvironment 的抽象引用。
dueDate	string	测试运行的截止日期和时间。
environmentDetails	DtlEnvironmentDetails	这是一个临时类，用于提供测试运行环境的详细信息。
errorMessage	string	与运行关联的错误消息。
filter	RunFilter	用于发现运行的筛选器。
iteration	string	要在其中创建运行的迭代。团队项目的根迭代将是默认值
name	string	测试运行的名称。
owner	IdentityRef	运行所有者的显示名称。
pipelineReference	PipelineReference	此测试运行所属的管道的引用。 PipelineReference.PipelineId 应等于 RunCreateModel.Build.Id
plan	ShallowReference	对它所属计划的抽象引用。
pointIds	integer[] (int32)	在运行中使用的测试点的 ID。
releaseEnvironmentUri	string	与运行关联的发布环境的 URI。
releaseReference	ReleaseReference	对与测试运行关联的发布的引用。
releaseUri	string	与运行关联的发布 URI。
runSummary	RunSummaryModel[]	运行类型 = NoConfigRun 的运行摘要。
runTimeout	string (TimeSpan)	时间跨度，直到运行超时。
sourceWorkflow	string	测试运行的 SourceWorkFlow（CI/CD）。
startDate	string	运行的开始日期时间。
state	string	运行的状态。类型 TestRunState 有效状态 - NotStarted、InProgress、Waiting
tags	TestTag[]	要随测试运行一起附加的标记，最多可以添加 5 个标记以运行。
testConfigurationsMapping	string	测试运行的 TestConfigurationMapping。
testEnvironmentId	string	与运行关联的测试环境的 ID。
testSettings	ShallowReference	对测试设置资源的抽象引用。
type	string	run（RunType）有效值的类型：（未指定、正常、阻止、Web、MtrRunInitiatedFromWeb、RunWithDtlEnv、NoConfigRun）

响应

名称	类型	说明
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_write	授予读取、创建和更新测试计划、事例、结果和其他测试管理相关项目的能力。

示例

示例请求

HTTP

POST https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/runs?api-version=7.1

{
  "name": "NewTestRun",
  "plan": {
    "id": "1"
  },
  "pointIds": [
    1,
    1
  ]
}

示例响应

状态代码:: 200

{
  "id": 31,
  "name": "NewTestRun",
  "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Runs/31",
  "isAutomated": false,
  "iteration": "Fabrikam-Fiber-TFVC\\Release 1\\Sprint 1",
  "owner": {
    "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabrikamfiber3@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
  },
  "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-28T16:39:00.44Z",
  "state": "InProgress",
  "plan": {
    "id": "1",
    "name": "sprint1",
    "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1"
  },
  "postProcessState": "Complete",
  "totalTests": 2,
  "incompleteTests": 2,
  "createdDate": "2014-05-28T16:39:00.4Z",
  "lastUpdatedDate": "2014-05-28T16:39:00.44Z",
  "lastUpdatedBy": {
    "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabrikamfiber3@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
  },
  "revision": 2
}

定义

名称	说明
BuildConfiguration	BuildConfiguration 详细信息。
CustomTestField	自定义字段信息。允许的键：值对 - （AttemptId： int 值，IsTestResultFlaky： bool）
DtlEnvironmentDetails	这是一个临时类，用于提供测试运行环境的详细信息。
IdentityRef
JobReference	管道中的作业。这与 YAML 中的矩阵相关。
PhaseReference	管道中的阶段
PipelineReference	管道参考
ReferenceLinks	表示 REST 引用链接集合的类。
ReleaseReference	对发布的引用。
ResultMetadata	给定结果/计数的 ResultMetadata。
RunCreateModel	测试运行创建详细信息。
RunFilter	此类用于提供用于发现的筛选器
RunStatistic	测试每个结果的运行统计信息。
RunSummaryModel	针对每个输出类型的测试运行摘要。
ShallowReference	对某些其他资源的抽象引用。此类用于提供生成数据协定的统一方法，以一种提供轻松遍历链接的方式引用其他资源。
StageReference	管道中的阶段
TestEnvironment	测试环境详细信息。
TestOutcome
TestResolutionState	测试解析状态详细信息。
TestRun	测试运行详细信息。
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	阶段的参考。

ReferenceLinks

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	重新运行元数据

RunCreateModel

Object

测试运行创建详细信息。

名称	类型	说明
automated	boolean	如果测试运行是自动化的，则为 true;否则为 false。默认情况下，它将为 false。
build	ShallowReference	对它所属的生成的抽象引用。
buildDropLocation	string	放置用于测试运行的生成的位置。
buildFlavor	string	用于测试运行的生成风格。（例如：发布、调试）
buildPlatform	string	用于测试运行的生成平台。（例如：x86、amd64）
buildReference	BuildConfiguration	测试运行的 BuildReference。
comment	string	分析运行的人员输入的注释。
completeDate	string	已完成的运行日期时间。
configurationIds	integer[] (int32)	与运行关联的测试配置的 ID。
controller	string	用于自动运行的测试控制器的名称。
customTestFields	CustomTestField[]	测试运行的其他属性。
dtlAutEnvironment	ShallowReference	对 DtlAutEnvironment 的抽象引用。
dtlTestEnvironment	ShallowReference	对 DtlTestEnvironment 的抽象引用。
dueDate	string	测试运行的截止日期和时间。
environmentDetails	DtlEnvironmentDetails	这是一个临时类，用于提供测试运行环境的详细信息。
errorMessage	string	与运行关联的错误消息。
filter	RunFilter	用于发现运行的筛选器。
iteration	string	要在其中创建运行的迭代。团队项目的根迭代将是默认值
name	string	测试运行的名称。
owner	IdentityRef	运行所有者的显示名称。
pipelineReference	PipelineReference	此测试运行所属的管道的引用。 PipelineReference.PipelineId 应等于 RunCreateModel.Build.Id
plan	ShallowReference	对它所属计划的抽象引用。
pointIds	integer[] (int32)	在运行中使用的测试点的 ID。
releaseEnvironmentUri	string	与运行关联的发布环境的 URI。
releaseReference	ReleaseReference	对与测试运行关联的发布的引用。
releaseUri	string	与运行关联的发布 URI。
runSummary	RunSummaryModel[]	运行类型 = NoConfigRun 的运行摘要。
runTimeout	string (TimeSpan)	时间跨度，直到运行超时。
sourceWorkflow	string	测试运行的 SourceWorkFlow（CI/CD）。
startDate	string	运行的开始日期时间。
state	string	运行的状态。类型 TestRunState 有效状态 - NotStarted、InProgress、Waiting
tags	TestTag[]	要随测试运行一起附加的标记，最多可以添加 5 个标记以运行。
testConfigurationsMapping	string	测试运行的 TestConfigurationMapping。
testEnvironmentId	string	与运行关联的测试环境的 ID。
testSettings	ShallowReference	对测试设置资源的抽象引用。
type	string	run（RunType）有效值的类型：（未指定、正常、阻止、Web、MtrRunInitiatedFromWeb、RunWithDtlEnv、NoConfigRun）

RunFilter

Object

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

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

RunStatistic

Object

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

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

RunSummaryModel

Object

针对每个输出类型的测试运行摘要。

名称	类型	说明
duration	integer (int64)	总时间（以毫秒为单位）。
resultCount	integer (int32)	结果 TestOutcome 的结果数
testOutcome	TestOutcome	摘要基于结果

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	测试环境名称。

TestOutcome

枚举

值	说明
aborted	测试已中止。这不是由用户手势造成的，而是由框架决策造成的。
blocked	测试有机会执行，但不是，因为 ITestElement.IsRunnable == false。
error	尝试执行测试时出现系统错误。
failed	测试已执行，但存在问题。问题可能涉及异常或失败断言。
inProgress	测试当前正在执行。为中医图表添加了此项
inconclusive	测试已完成，但我们无法说明它是否已通过或失败。可用于中止的测试...
none	测试尚未完成，或者测试类型不报告通过/失败。
notApplicable	测试不适用于执行。
notExecuted	未执行测试。这是由用户手势引起的，例如用户点击停止按钮。
notImpacted	测试不受影响。添加了 fot TIA。
passed	测试已执行，但出现任何问题。
paused	测试已暂停。
timeout	测试超时
unspecified	仅在更新期间使用以保留现有值。
warning	由运行级别结果使用。这不是失败。

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。

TestRunSubstate

枚举

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

值	说明
abortedBySystem	由系统中止时运行状态。
analyzed	分析后运行状态。
canceledByUser	创建环境时运行状态。
cancellationInProgress	取消正在进行时运行状态。
creatingEnvironment	创建环境时运行状态。
none	使用 noState 运行。
pendingAnalysis	挂起分析时运行状态。
runningTests	运行测试时运行状态。
timedOut	运行时运行状态为 timedOut。

TestTag

Object

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

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

通过

Runs - Create

URI 参数

请求正文

响应

安全性

oauth2

作用域

示例

示例请求

示例响应

定义

BuildConfiguration

CustomTestField

DtlEnvironmentDetails

IdentityRef

JobReference

PhaseReference

PipelineReference

ReferenceLinks

ReleaseReference

ResultMetadata

RunCreateModel

RunFilter

RunStatistic

RunSummaryModel

ShallowReference

StageReference

TestEnvironment

TestOutcome

TestResolutionState

TestRun

TestRunSubstate

TestTag