Wiql - Query By Wiql

リファレンス

Service:: Work Item Tracking

API Version:: 6.1-preview.2

WIQL を指定してクエリの結果を取得します。

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

With optional parameters:

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 のバージョン。このバージョンの API を使用するには、これを '6.1-preview.2' に設定する必要があります。
$top	query		integer int32	返される結果の最大数。
timePrecision	query		boolean	時間精度を使用するかどうか。

要求本文

名前	型	説明
query	string	WIQL クエリのテキスト

応答

名前	型	説明
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

名前	説明
vso.work	作業項目、クエリ、ボード、領域およびイテレーションパス、およびその他の作業項目追跡関連のメタデータを読み取る機能を付与します。また、クエリを実行したり、作業項目を検索したり、サービスフックを介して作業項目イベントに関する通知を受信したりすることもできます。

例

Get results of a flat work item query.

Sample Request

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

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

定義

名前	説明
QueryResultType	結果の種類です。
QueryType	クエリの種類。
Wiql	WIQL クエリ
WorkItemFieldReference	作業項目内のフィールドへの参照
WorkItemLink	2 つの作業項目間のリンク。
WorkItemQueryResult	作業項目クエリの結果。
WorkItemQuerySortColumn	並べ替え列。
WorkItemReference	作業項目への参照を含みます。

QueryResultType

結果の種類です。

名前	型	説明
workItem	string	作業項目の一覧 (フラットクエリの場合)。
workItemLink	string	作業項目のリンクの一覧 (OneHop およびツリークエリの場合)。

QueryType

クエリの種類。

名前	型	説明
flat	string	作業項目のフラットな一覧を取得します。
oneHop	string	作業項目とその直接リンクの一覧を取得します。
tree	string	リンク階層を示す作業項目のツリーを取得します。

Wiql

WIQL クエリ

名前	型	説明
query	string	WIQL クエリのテキスト

WorkItemFieldReference

作業項目内のフィールドへの参照

名前	型	説明
name	string	フィールドのフレンドリ名。
referenceName	string	フィールドの参照名。
url	string	リソースの REST URL。

WorkItemLink

2 つの作業項目間のリンク。

名前	型	説明
rel	string	リンクの種類です。
source	WorkItemReference	ソース作業項目。
target	WorkItemReference	対象の作業項目。

WorkItemQueryResult

作業項目クエリの結果。

名前	型	説明
asOf	string	コンテキストでクエリが実行された日付。
columns	WorkItemFieldReference[]	クエリの列。
queryResultType	QueryResultType	結果の種類です。
queryType	QueryType	クエリの種類
sortColumns	WorkItemQuerySortColumn[]	クエリの並べ替え列。
workItemRelations	WorkItemLink[]	クエリによって返される作業項目のリンク。
workItems	WorkItemReference[]	クエリによって返される作業項目。

WorkItemQuerySortColumn

並べ替え列。

名前	型	説明
descending	boolean	並べ替えの基準となる方向。
field	WorkItemFieldReference	作業項目フィールド。

WorkItemReference

作業項目への参照を含みます。

名前	型	説明
id	integer	作業項目 ID。
url	string	リソースの REST API URL

次の方法で共有