Wiql - Get
Gets the results of the query given the query ID.
HEAD https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/wiql/{id}?api-version=7.1
HEAD https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/wiql/{id}?timePrecision={timePrecision}&$top={$top}&api-version=7.1
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
id
|
path | True |
string uuid |
The query ID. |
organization
|
path | True |
string |
The name of the Azure DevOps organization. |
project
|
path |
string |
Project ID or project name |
|
team
|
path |
string |
Team ID or team name |
|
api-version
|
query | True |
string |
Version of the API to use. This should be set to '7.1' to use this version of the api. |
$top
|
query |
integer int32 |
The max number of results to return. |
|
time
|
query |
boolean |
Whether or not to use time precision. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
integer |
successful operation |
Security
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
Name | Description |
---|---|
vso.work | Grants the ability to read work items, queries, boards, area and iterations paths, and other work item tracking related metadata. Also grants the ability to execute queries, search work items and to receive notifications about work item events via service hooks. |
Examples
Sample request
HEAD https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/wiql/{id}?api-version=7.1
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"
}
}
]
}