Session - List

参考

服务:: Test

API 版本:: 7.1

获取测试会话列表

GET https://dev.azure.com/{organization}/{project}/{team}/_apis/test/session?api-version=7.1

具有可选参数:

GET https://dev.azure.com/{organization}/{project}/{team}/_apis/test/session?period={period}&allSessions={allSessions}&includeAllProperties={includeAllProperties}&source={source}&includeOnlyCompletedSessions={includeOnlyCompletedSessions}&api-version=7.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
team	path		string	团队 ID 或团队名称
api-version	query	True	string	要使用的 API 版本。这应设置为“7.1”才能使用此版本的 API。
allSessions	query		boolean	如果为 false，则返回当前用户的测试会话。否则，它将返回所有用户的测试会话
includeAllProperties	query		boolean	如果为 true，则返回测试会话的所有属性。否则，它将返回瘦身版本。
includeOnlyCompletedSessions	query		boolean	如果为 true，则返回处于已完成状态的测试会话。否则，它将返回所有状态的测试会话
period	query		integer (int32)	从现在起的天数内，将提取测试会话。
source	query		TestSessionSource	测试会话的源。

响应

名称	类型	说明
200 OK	TestSession[]	成功作

安全性

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

示例

示例请求

HTTP

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-TFVC/Fabrikam-Fiber-TFVC Team/_apis/test/session?api-version=7.1

示例响应

状态代码:: 200

{
  "count": 2,
  "value": [
    {
      "id": 10,
      "title": "Session - 6/30/2016, 3:41:41 PM",
      "startDate": "2016-06-30T10:11:41.357Z",
      "endDate": "2016-06-30T10:13:15.253Z",
      "revision": 2,
      "source": "xtWeb",
      "state": "completed",
      "owner": {
        "id": "6225fa20-adf2-42dc-851e-168c0d05a628",
        "displayName": "prabin"
      },
      "propertyBag": {
        "bag": {
          "AssociatedWorkItem": "[{\"id\":10,\"type\":\"Task\"},{\"id\":7,\"type\":\"Bug\"},{\"id\":8,\"type\":\"Task\"},{\"id\":9,\"type\":\"Test Case\"}]",
          "ExploredWorkItem": "[{\"startTime\":\"2016-06-30T10:13:04.393Z\",\"endTime\":\"2016-06-30T10:13:15.19Z\",\"id\":2,\"type\":\"Test Case\"}]"
        }
      }
    },
    {
      "id": 11,
      "title": "Session - 6/30/2016, 3:43:16 PM",
      "startDate": "2016-06-30T10:13:16.317Z",
      "endDate": "2016-06-30T10:13:33.297Z",
      "revision": 2,
      "source": "xtWeb",
      "state": "completed",
      "owner": {
        "id": "6225fa20-adf2-42dc-851e-168c0d05a628",
        "displayName": "prabin"
      },
      "propertyBag": {
        "bag": {
          "AssociatedWorkItem": "[{\"id\":11,\"type\":\"Test Case\"}]",
          "ExploredWorkItem": "[{\"startTime\":\"2016-06-30T10:13:29.957Z\",\"endTime\":\"2016-06-30T10:13:33.283Z\",\"id\":3,\"type\":\"Test Case\"}]"
        }
      }
    }
  ]
}

定义

名称	说明
IdentityRef
PropertyBag	用于表示测试会话数据的泛型存储的类。
ReferenceLinks	表示 REST 引用链接集合的类。
ShallowReference	对某些其他资源的抽象引用。此类用于提供生成数据协定的统一方法，以一种提供轻松遍历链接的方式引用其他资源。
TestSession	测试会话
TestSessionSource	测试会话的源
TestSessionState	测试会话的状态

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

PropertyBag

Object

用于表示测试会话数据的泛型存储的类。

名称	类型	说明
bag	object	测试会话数据的通用存储

ReferenceLinks

Object

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

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

ShallowReference

Object

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

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

TestSession

Object

测试会话

名称	类型	说明
area	ShallowReference	测试会话的区域路径
comment	string	测试会话中的注释
endDate	string (date-time)	会话持续时间
id	integer (int32)	测试会话的 ID
lastUpdatedBy	IdentityRef	上次按参考更新
lastUpdatedDate	string (date-time)	上次更新时间
owner	IdentityRef	测试会话的所有者
project	ShallowReference	测试会话所属的项目
propertyBag	PropertyBag	测试会话数据的通用存储
revision	integer (int32)	测试会话的修订
source	TestSessionSource	测试会话的源
startDate	string (date-time)	开始日期
state	TestSessionState	测试会话的状态
title	string	测试会话的标题
url	string	测试会话资源的 URL

TestSessionSource

枚举

测试会话的源

值	说明
feedbackDesktop	会话是从反馈客户端创建的。
feedbackWeb	会话是从浏览器扩展创建的。
sessionInsightsForAll	显示来自所有受支持源的会话。
unknown	测试会话的源不确定，因为它已过时
xtDesktop	会话是从Microsoft测试管理器探索桌面工具创建的。
xtDesktop2	会话是使用Microsoft测试管理器探索桌面工具从 Web 访问创建的。
xtWeb	会话是从浏览器扩展创建的。

TestSessionState

枚举

测试会话的状态

值	说明
completed	会话已完成。
declined	这是拒绝的反馈会话所必需的
inProgress	会话正在运行。
notStarted	会话仍在创建中。
paused	会话已暂停。
unspecified	仅在更新期间使用以保留现有值。

通过

Session - List

URI 参数

响应

安全性

oauth2

作用域

示例

示例请求

示例响应

定义

IdentityRef

PropertyBag

ReferenceLinks

ShallowReference

TestSession

TestSessionSource

TestSessionState