Wiql - Query By Wiql

Başvuru

Service:: Work Item Tracking

API Version:: 6.0

WIQL'sine göre sorgunun sonuçlarını alır.

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

With optional parameters:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
organization	path	True	string	Azure DevOps kuruluşunun adı.
project	path		string	Proje Kimliği veya proje adı
team	path		string	Ekip kimliği veya ekip adı
api-version	query	True	string	Kullanılacak API'nin sürümü. Bu, api'nin bu sürümünü kullanmak için '6.0' olarak ayarlanmalıdır.
$top	query		integer int32	Döndürülecek en fazla sonuç sayısı.
timePrecision	query		boolean	Zaman duyarlığı kullanılıp kullanılmaymayacağı.

İstek Gövdesi

Name	Tür	Description
query	string	WIQL sorgusunun metni

Yanıtlar

Name	Tür	Description
200 OK	WorkItemQueryResult	başarılı işlem

Güvenlik

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	İş öğelerini, sorguları, panoları, alan ve yineleme yollarını ve diğer iş öğesi izlemeyle ilgili meta verileri okuma olanağı verir. Ayrıca sorguları yürütme, iş öğelerini arama ve hizmet kancaları aracılığıyla iş öğesi olayları hakkında bildirim alma olanağı verir.

Örnekler

Get results of a flat work item query.

Sample Request

HTTP

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

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

Tanımlar

Name	Description
QueryResultType	Sonuç türü
QueryType	Sorgu türü.
Wiql	WIQL sorgusu
WorkItemFieldReference	İş öğesindeki bir alana başvuru
WorkItemLink	İki iş öğesi arasındaki bağlantı.
WorkItemQueryResult	İş öğesi sorgusunun sonucu.
WorkItemQuerySortColumn	Sıralama sütunu.
WorkItemReference	bir iş öğesine başvuru içerir.

QueryResultType

Sonuç türü

Name	Tür	Description
workItem	string	İş öğelerinin listesi (düz sorgular için).
workItemLink	string	İş öğesi bağlantılarının listesi (OneHop ve Ağaç sorguları için).

QueryType

Sorgu türü.

Name	Tür	Description
flat	string	İş öğelerinin düz bir listesini alır.
oneHop	string	İş öğelerinin ve bunların doğrudan bağlantılarının listesini alır.
tree	string	Bağlantı hiyerarşilerini gösteren bir iş öğesi ağacı alır.

Wiql

WIQL sorgusu

Name	Tür	Description
query	string	WIQL sorgusunun metni

WorkItemFieldReference

İş öğesindeki bir alana başvuru

Name	Tür	Description
name	string	Alanın kolay adı.
referenceName	string	Alanın başvuru adı.
url	string	Kaynağın REST URL'si.

WorkItemLink

İki iş öğesi arasındaki bağlantı.

Name	Tür	Description
rel	string	Bağlantı türü.
source	WorkItemReference	Kaynak iş öğesi.
target	WorkItemReference	Hedef iş öğesi.

WorkItemQueryResult

İş öğesi sorgusunun sonucu.

Name	Tür	Description
asOf	string	Sorgunun bağlamında çalıştırıldığı tarih.
columns	WorkItemFieldReference[]	Sorgunun sütunları.
queryResultType	QueryResultType	Sonuç türü
queryType	QueryType	Sorgunun türü
sortColumns	WorkItemQuerySortColumn[]	Sorgunun sıralama sütunları.
workItemRelations	WorkItemLink[]	sorgu tarafından döndürülen iş öğesi bağlantıları.
workItems	WorkItemReference[]	Sorgu tarafından döndürülen iş öğeleri.

WorkItemQuerySortColumn

Sıralama sütunu.

Name	Tür	Description
descending	boolean	Sıralama ölçütü.
field	WorkItemFieldReference	İş öğesi alanı.

WorkItemReference

bir iş öğesine başvuru içerir.

Name	Tür	Description
id	integer	İş öğesi kimliği.
url	string	Kaynağın REST API URL'si

Aracılığıyla paylaş