通过

Suite Test Case - Get Test Case List

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

获取测试用例列表返回具有可选参数中所述的所有配置 ID 的测试用例。 如果配置 ID 为 null，则返回所有测试用例

GET https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}/TestCase?api-version=7.1
具有可选参数: 
GET https://dev.azure.com/{organization}/{project}/_apis/testplan/Plans/{planId}/Suites/{suiteId}/TestCase?testIds={testIds}&configurationIds={configurationIds}&witFields={witFields}&continuationToken={continuationToken}&returnIdentityRef={returnIdentityRef}&expand={expand}&excludeFlags={excludeFlags}&isRecursive={isRecursive}&api-version=7.1

URI 参数

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

string

Azure DevOps 组织的名称。
planId
 path True

integer (int32)

请求测试用例的测试计划的 ID。
project
 path True

string

项目 ID 或项目名称
suiteId
 path True

integer (int32)

为其请求测试用例的测试套件的 ID。
api-version
 query True

string

要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。
configurationIds
 query

string

提取包含指定的所有配置 ID 的测试用例。
continuationToken
 query

string

如果返回的测试用例列表未完成，则响应标头中将查询下一批测试用例的延续标记作为“x-ms-continuationtoken” 包含在响应标头中。 省略此参数以获取第一批测试用例。
excludeFlags
 query

ExcludeFlags

用于从有效负载中排除各种值的标志。 例如，删除点分配传递排除 = 1。 若要删除额外信息（链接、测试计划、测试套件）通过排除 = 2。 若要删除额外信息和点分配，请排除 = 3 （1 + 2）。
expand
 query

boolean

如果设置为 false，将获取仅包含套件测试用例对象的基本详细信息的较小有效负载
isRecursive
 query

boolean

returnIdentityRef
 query

boolean

如果设置为 true，则返回所有标识字段（如 AssignedTo、ActivatedBy 等）作为 IdentityRef 对象。 如果设置为 false，则以字符串格式将这些字段作为唯一名称返回。 默认情况下，这是 false。
testIds
 query

string

要提取的测试用例 ID。
witFields
 query

string

获取 witFields 的列表。

响应

名称 类型 说明
200 OK

TestCase[]

成功作

安全性

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

定义

名称 说明
ExcludeFlags

用于从有效负载中排除各种值的标志。 例如，删除点分配传递排除 = 1。 若要删除额外信息（链接、测试计划、测试套件）通过排除 = 2。 若要删除额外信息和点分配，请排除 = 3 （1 + 2）。
IdentityRef
PointAssignment

测试点的分配
ProjectState

项目状态。
ProjectVisibility

项目可见性。
ReferenceLinks

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

表示对 TeamProject 的浅表引用。
TestCase

测试用例类
TestPlanReference

测试计划参考资源。
TestSuiteReference

测试套件参考资源。
WorkItemDetails

工作项类

ExcludeFlags

枚举

用于从有效负载中排除各种值的标志。 例如，删除点分配传递排除 = 1。 若要删除额外信息（链接、测试计划、测试套件）通过排除 = 2。 若要删除额外信息和点分配，请排除 = 3 （1 + 2）。

值 说明
extraInformation

若要排除额外信息（链接、测试计划、测试套件），通过排除 = 2
none

不排除任何内容
pointAssignments

若要排除点分配，传递 exclude = 1

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 是指向此图形主题的源资源的完整路由。

PointAssignment

Object

测试点的分配

名称 类型 说明
configurationId

integer (int32)

分配给测试点的配置的 ID
configurationName

string

分配给测试点的配置的名称
id

integer (int32)

测试点的 ID
tester

IdentityRef

分配给测试点的测试人员

ProjectState

枚举

项目状态。

值 说明
all

所有项目，无论状态如何，都已删除。
createPending

项目已排队创建，但该过程尚未启动。
deleted

项目已被删除。
deleting

项目正在删除。
new

正在创建项目。
unchanged

项目尚未更改。
wellFormed

项目已完全创建并可供使用。

ProjectVisibility

枚举

项目可见性。

值 说明
private

只有具有显式访问权限的用户才能看到该项目。
public

项目对所有人可见。
Object

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

名称 类型 说明
links

object

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

TeamProjectReference

Object

表示对 TeamProject 的浅表引用。

名称 类型 说明
abbreviation

string

项目缩写。
defaultTeamImageUrl

string

指向默认团队标识映像的 URL。
description

string

项目的说明（如果有）。
id

string (uuid)

项目标识符。
lastUpdateTime

string (date-time)

上次更新时间的项目。
name

string

项目名称。
revision

integer (int64)

项目修订。
state

ProjectState

项目状态。
url

string

指向对象完整版本的 URL。
visibility

ProjectVisibility

项目可见性。

TestCase

Object

测试用例类

名称 类型 说明
links

ReferenceLinks

参考链接
order

integer (int32)

Suite 中 TestCase 的顺序
pointAssignments

PointAssignment[]

与测试用例关联的点列表
project

TeamProjectReference

测试用例所在的项目
testPlan

TestPlanReference

测试用例所在的测试计划
testSuite

TestSuiteReference

测试用例所在的测试套件
workItem

WorkItemDetails

TestCase 的工作项详细信息

TestPlanReference

Object

测试计划参考资源。

名称 类型 说明
id

integer (int32)

测试计划的 ID。
name

string

测试计划的名称。

TestSuiteReference

Object

测试套件参考资源。

名称 类型 说明
id

integer (int32)

测试套件的 ID。
name

string

测试套件的名称。

WorkItemDetails

Object

工作项类

名称 类型 说明
id

integer (int32)

工作项 ID
name

string

工作项名称
workItemFields

object[]

工作项字段