Wiql - Query By Wiql

Service:: 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 パラメーター

Name	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前。
project	path		string	プロジェクト ID またはプロジェクト名
team	path		string	チーム ID またはチーム名
api-version	query	True	string	使用する API のバージョン。このバージョンの API を使用するには、これを '7.1' に設定する必要があります。
$top	query		integer (int32)	返される結果の最大数。
timePrecision	query		boolean	時間の有効桁数を使用するかどうか。

要求本文

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

応答

Name	型	説明
200 OK	WorkItemQueryResult	成功した操作

セキュリティ

oauth2

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL (トークン 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

スコープ

Name	説明
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"
    }
  ]
}

定義

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

QueryResultType

列挙

結果の種類

値	説明
workItem	作業項目の一覧 (フラットクエリの場合)。
workItemLink	作業項目のリンクの一覧 (OneHop クエリとツリークエリの場合)。

QueryType

列挙

クエリの種類。

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

Wiql

Object

WIQL クエリ

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

WorkItemFieldReference

Object

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

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

WorkItemLink

Object

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

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

WorkItemQueryResult

Object

作業項目クエリの結果。

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

WorkItemQuerySortColumn

Object

並べ替え列。

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

WorkItemReference

Object

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

Name	型	説明
id	integer (int32)	作業項目 ID。
url	string	リソースの REST API URL

フィードバック

このページはお役に立ちましたか?