次の方法で共有


Wiql - Query By Id

クエリ ID が指定されたクエリの結果を取得します。

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

URI パラメーター

名前 / 必須 説明
id
path True

string

uuid

クエリ ID。

organization
path True

string

Azure DevOps 組織の名前です。

project
path

string

プロジェクト ID またはプロジェクト名

team
path

string

チーム ID またはチーム名

api-version
query True

string

使う API のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.2' に設定する必要があります。

$top
query

integer

int32

返される結果の最大数。

timePrecision
query

boolean

時間の有効桁数を使用するかどうか。

応答

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

Sample Request

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/wiql/{id}?api-version=7.1-preview.2

Sample Response

{
  "queryType": "tree",
  "asOf": "2014-12-29T20:49:33.803Z",
  "columns": [
    {
      "referenceName": "System.Id",
      "name": "ID",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Id"
    },
    {
      "referenceName": "System.WorkItemType",
      "name": "Work Item Type",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.WorkItemType"
    },
    {
      "referenceName": "System.Title",
      "name": "Title",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
    },
    {
      "referenceName": "System.AssignedTo",
      "name": "Assigned To",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.AssignedTo"
    },
    {
      "referenceName": "System.State",
      "name": "State",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.State"
    }
  ],
  "workItemRelations": [
    {
      "target": {
        "id": 4,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/4"
      }
    },
    {
      "target": {
        "id": 5,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/5"
      }
    },
    {
      "target": {
        "id": 6,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/6"
      }
    },
    {
      "target": {
        "id": 7,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/7"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 7,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/7"
      },
      "target": {
        "id": 8,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/8"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 7,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/7"
      },
      "target": {
        "id": 9,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/9"
      }
    },
    {
      "target": {
        "id": 11,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/11"
      }
    },
    {
      "target": {
        "id": 12,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/12"
      }
    },
    {
      "target": {
        "id": 20,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/20"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 20,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/20"
      },
      "target": {
        "id": 1,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/1"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 20,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/20"
      },
      "target": {
        "id": 2,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/2"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 20,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/20"
      },
      "target": {
        "id": 3,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/3"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 20,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/20"
      },
      "target": {
        "id": 10,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 10,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
      },
      "target": {
        "id": 13,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/13"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 10,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
      },
      "target": {
        "id": 14,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/14"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 10,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
      },
      "target": {
        "id": 15,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/15"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 10,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
      },
      "target": {
        "id": 16,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/16"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 10,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
      },
      "target": {
        "id": 17,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/17"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 10,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
      },
      "target": {
        "id": 18,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/18"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 10,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
      },
      "target": {
        "id": 19,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/19"
      }
    },
    {
      "target": {
        "id": 21,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/21"
      }
    },
    {
      "target": {
        "id": 33,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/33"
      }
    },
    {
      "target": {
        "id": 34,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/34"
      }
    },
    {
      "target": {
        "id": 46,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/46"
      }
    },
    {
      "target": {
        "id": 47,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/47"
      }
    },
    {
      "target": {
        "id": 58,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/58"
      }
    },
    {
      "target": {
        "id": 59,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/59"
      }
    },
    {
      "target": {
        "id": 297,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/297"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 297,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/297"
      },
      "target": {
        "id": 299,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/299"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 297,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/297"
      },
      "target": {
        "id": 300,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/300"
      }
    },
    {
      "target": {
        "id": 298,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/298"
      }
    }
  ]
}

定義

名前 説明
QueryResultType

結果の種類です。

QueryType

クエリの種類。

WorkItemFieldReference

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

WorkItemLink

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

WorkItemQueryResult

作業項目クエリの結果。

WorkItemQuerySortColumn

並べ替え列。

WorkItemReference

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

QueryResultType

結果の種類です。

名前 説明
workItem

string

作業項目の一覧 (フラット クエリの場合)。

workItemLink

string

作業項目のリンクの一覧 (OneHop クエリとツリー クエリの場合)。

QueryType

クエリの種類。

名前 説明
flat

string

作業項目のフラット リストを取得します。

oneHop

string

作業項目とその直接リンクの一覧を取得します。

tree

string

リンク階層を示す作業項目のツリーを取得します。

WorkItemFieldReference

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

名前 説明
name

string

フィールドのフレンドリ名。

referenceName

string

フィールドの参照名。

url

string

リソースの REST URL。

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