Wiql - Query By Wiql

參考

Service:: Work Item Tracking

API Version:: 7.1-preview.2

取得指定其 WIQL 之查詢的結果。

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

With optional parameters:

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

URI 參數

名稱	位於	必要	類型	Description
organization	path	True	string	Azure DevOps 組織的名稱。
project	path		string	專案識別碼或專案名稱
team	path		string	小組識別碼或小組名稱
api-version	query	True	string	要使用的 API 版本。這應該設定為 '7.1-preview.2' 以使用此版本的 API。
$top	query		integer int32	要傳回的結果數目上限。
timePrecision	query		boolean	是否要使用時間精確度。

要求本文

名稱	類型	Description
query	string	WIQL 查詢的文字

回應

名稱	類型	Description
200 OK	WorkItemQueryResult	成功的作業

安全性

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token 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

Scopes

名稱	Description
vso.work	授與讀取工作專案、查詢、面板、區域和反復專案路徑，以及其他工作專案追蹤相關中繼資料的能力。也授與執行查詢、搜尋工作專案，以及透過服務勾點接收工作專案事件通知的能力。

範例

Get results of a flat work item query.

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/_apis/wit/wiql?api-version=7.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"
}

Sample Response

Status code:: 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"
    }
  ]
}

定義

名稱	Description
QueryResultType	結果類型。
QueryType	查詢的類型。
Wiql	WIQL 查詢
WorkItemFieldReference	工作專案中欄位的參考
WorkItemLink	兩個工作專案之間的連結。
WorkItemQueryResult	工作專案查詢的結果。
WorkItemQuerySortColumn	排序資料行。
WorkItemReference	包含工作專案的參考。

QueryResultType

結果類型。

名稱	類型	Description
workItem	string	) 一般查詢的工作專案清單 (。
workItemLink	string	OneHop 和樹狀結構查詢 (的工作專案連結清單) 。

QueryType

查詢的類型。

名稱	類型	Description
flat	string	取得工作專案的一般清單。
oneHop	string	取得工作專案及其直接連結的清單。
tree	string	取得顯示其連結階層的工作專案樹狀結構。

Wiql

WIQL 查詢

名稱	類型	Description
query	string	WIQL 查詢的文字

WorkItemFieldReference

工作專案中欄位的參考

名稱	類型	Description
name	string	欄位的易記名稱。
referenceName	string	欄位的參考名稱。
url	string	資源的 REST URL。

WorkItemLink

兩個工作專案之間的連結。

名稱	類型	Description
rel	string	連結類型。
source	WorkItemReference	來源工作專案。
target	WorkItemReference	目標工作專案。

WorkItemQueryResult

工作專案查詢的結果。

名稱	類型	Description
asOf	string	查詢在內容中執行的日期。
columns	WorkItemFieldReference[]	查詢的資料行。
queryResultType	QueryResultType	結果類型。
queryType	QueryType	查詢的類型
sortColumns	WorkItemQuerySortColumn[]	查詢的排序資料行。
workItemRelations	WorkItemLink[]	查詢所傳回的工作專案連結。
workItems	WorkItemReference[]	查詢所傳回的工作專案。

WorkItemQuerySortColumn

排序資料行。

名稱	類型	Description
descending	boolean	排序依據的方向。
field	WorkItemFieldReference	工作專案欄位。

WorkItemReference

包含工作專案的參考。

名稱	類型	Description
id	integer	工作專案識別碼。
url	string	資源的 REST API URL