Wiql - Query By Wiql

參考

服務:: Work Item Tracking

API 版本:: 7.1

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

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

含選擇性參數:

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

URI 參數

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

要求本文

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

回應

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

安全性

oauth2

類型: oauth2
Flow: 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

範圍

名稱	Description
vso.work	授與讀取工作項目、查詢、面板、區域和反覆項目路徑，以及其他工作專案追蹤相關元數據的能力。同時授與執行查詢、搜尋工作專案，以及透過服務攔截接收工作專案事件的通知的能力。

範例

Get results of a flat work item query.

範例要求

HTTP

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

{
  "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"
    }
  ]
}

定義

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

QueryResultType

列舉型別

結果類型

值	Description
workItem	工作專案清單（適用於一般查詢）。
workItemLink	工作專案連結的清單（適用於 OneHop 和樹狀結構查詢）。

QueryType

列舉型別

查詢的類型。

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

Wiql

Object

WIQL 查詢

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

WorkItemFieldReference

Object

工作專案中欄位的參考

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

WorkItemLink

Object

兩個工作項目之間的連結。

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

WorkItemQueryResult

Object

工作項目查詢的結果。

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

WorkItemQuerySortColumn

Object

排序數據行。

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

WorkItemReference

Object

包含工作項目的參考。

名稱	類型	Description
id	integer (int32)	工作項目識別碼。
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