Wiql - Query By Wiql

参考

服务:: Work Item Tracking

API 版本:: 6.1-preview.2

获取给定其 WIQL 的查询结果。

POST https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/wiql?api-version=6.1-preview.2

具有可选参数:

POST https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/wiql?timePrecision={timePrecision}&$top={$top}&api-version=6.1-preview.2

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path		string	项目 ID 或项目名称
team	path		string	团队 ID 或团队名称
api-version	query	True	string	要使用的 API 版本。这应设置为“6.1-preview.2”才能使用此版本的 API。
$top	query		integer (int32)	要返回的最大结果数。
timePrecision	query		boolean	是否使用时间精度。

请求正文

名称	类型	说明
query	string	WIQL 查询的文本

响应

名称	类型	说明
200 OK	WorkItemQueryResult	成功作

安全性

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.work	授予读取工作项、查询、版块、区域和迭代路径以及其他工作项跟踪相关元数据的能力。此外，还授予执行查询、搜索工作项以及通过服务挂钩接收有关工作项事件的通知的能力。

示例

Get results of a flat work item query.

示例请求

HTTP

POST https://dev.azure.com/fabrikam/_apis/wit/wiql?api-version=6.1-preview.2

{
  "query": "Select [System.Id], [System.Title], [System.State] From WorkItems Where [System.WorkItemType] = 'Task' AND [State] <> 'Closed' AND [State] <> 'Removed' order by [Microsoft.VSTS.Common.Priority] asc, [System.CreatedDate] desc"
}

示例响应

状态代码:: 200

{
  "queryType": "flat",
  "asOf": "2014-12-29T20:49:34.617Z",
  "columns": [
    {
      "referenceName": "System.Id",
      "name": "ID",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Id"
    },
    {
      "referenceName": "System.Title",
      "name": "Title",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
    },
    {
      "referenceName": "System.State",
      "name": "State",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.State"
    }
  ],
  "sortColumns": [
    {
      "field": {
        "referenceName": "Microsoft.VSTS.Common.Priority",
        "name": "Priority",
        "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.Priority"
      },
      "descending": false
    },
    {
      "field": {
        "referenceName": "System.CreatedDate",
        "name": "Created Date",
        "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.CreatedDate"
      },
      "descending": true
    }
  ],
  "workItems": [
    {
      "id": 300,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/300"
    },
    {
      "id": 299,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/299"
    },
    {
      "id": 298,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/298"
    },
    {
      "id": 17,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/17"
    },
    {
      "id": 16,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/16"
    },
    {
      "id": 15,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/15"
    },
    {
      "id": 14,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/14"
    },
    {
      "id": 9,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/9"
    },
    {
      "id": 8,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/8"
    }
  ]
}

定义

名称	说明
QueryResultType	结果类型
QueryType	查询的类型。
Wiql	WIQL 查询
WorkItemFieldReference	对工作项中的字段的引用
WorkItemLink	两个工作项之间的链接。
WorkItemQueryResult	工作项查询的结果。
WorkItemQuerySortColumn	排序列。
WorkItemReference	包含对工作项的引用。

QueryResultType

枚举

结果类型

值	说明
workItem	工作项列表（适用于平面查询）。
workItemLink	工作项链接列表（适用于 OneHop 和树查询）。

QueryType

枚举

查询的类型。

值	说明
flat	获取工作项的平面列表。
oneHop	获取工作项及其直接链接的列表。
tree	获取显示其链接层次结构的工作项树。

Wiql

Object

WIQL 查询

名称	类型	说明
query	string	WIQL 查询的文本

WorkItemFieldReference

Object

对工作项中的字段的引用

名称	类型	说明
name	string	字段的友好名称。
referenceName	string	字段的引用名称。
url	string	资源的 REST URL。

WorkItemLink

Object

两个工作项之间的链接。

名称	类型	说明
rel	string	链接的类型。
source	WorkItemReference	源工作项。
target	WorkItemReference	目标工作项。

WorkItemQueryResult

Object

工作项查询的结果。

名称	类型	说明
asOf	string (date-time)	查询在上下文中运行的日期。
columns	WorkItemFieldReference[]	查询的列。
queryResultType	QueryResultType	结果类型
queryType	QueryType	查询的类型
sortColumns	WorkItemQuerySortColumn[]	查询的排序列。
workItemRelations	WorkItemLink[]	查询返回的工作项链接。
workItems	WorkItemReference[]	查询返回的工作项。

WorkItemQuerySortColumn

Object

排序列。

名称	类型	说明
descending	boolean	排序依据的方向。
field	WorkItemFieldReference	工作项字段。

WorkItemReference

Object

包含对工作项的引用。

名称	类型	说明
id	integer (int32)	工作项 ID。
url	string	资源的 REST API URL

通过

Wiql - Query By Wiql

URI 参数

请求正文

响应

安全性

oauth2

作用域

示例

Get results of a flat work item query.

示例请求

示例响应

定义

QueryResultType

QueryType

Wiql

WorkItemFieldReference

WorkItemLink

WorkItemQueryResult

WorkItemQuerySortColumn

WorkItemReference