Wiql - Query By Wiql

Referensi

Service:: Work Item Tracking

API Version:: 7.1-preview.2

Mendapatkan hasil kueri yang diberikan WIQL-nya.

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

With optional parameters:

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
organization	path	True	string	Nama organisasi Azure DevOps.
project	path		string	ID proyek atau nama proyek
team	path		string	ID tim atau nama tim
api-version	query	True	string	Versi API yang akan digunakan. Ini harus diatur ke '7.1-preview.2' untuk menggunakan versi api ini.
$top	query		integer int32	Jumlah maksimum hasil yang akan dikembalikan.
timePrecision	query		boolean	Apakah akan menggunakan presisi waktu atau tidak.

Isi Permintaan

Nama	Jenis	Deskripsi
query	string	Teks kueri WIQL

Respons

Nama	Jenis	Deskripsi
200 OK	WorkItemQueryResult	operasi berhasil

Keamanan

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

Nama	Deskripsi
vso.work	Memberikan kemampuan untuk membaca item kerja, kueri, papan, jalur area dan iterasi, dan metadata terkait pelacakan item kerja lainnya. Juga memberikan kemampuan untuk menjalankan kueri, mencari item kerja, dan menerima pemberitahuan tentang peristiwa item kerja melalui kait layanan.

Contoh

Get results of a flat work item query.

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/_apis/wit/wiql?api-version=7.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"
    }
  ]
}

Definisi

Nama	Deskripsi
QueryResultType	Jenis hasil
QueryType	Jenis kueri.
Wiql	Kueri WIQL
WorkItemFieldReference	Referensi ke bidang dalam item kerja
WorkItemLink	Tautan antara dua item kerja.
WorkItemQueryResult	Hasil kueri item kerja.
WorkItemQuerySortColumn	Kolom pengurutan.
WorkItemReference	Berisi referensi ke item kerja.

QueryResultType

Jenis hasil

Nama	Jenis	Deskripsi
workItem	string	Daftar item kerja (untuk kueri datar).
workItemLink	string	Daftar tautan item kerja (untuk kueri OneHop dan Pohon).

QueryType

Jenis kueri.

Nama	Jenis	Deskripsi
flat	string	Mendapatkan daftar datar item kerja.
oneHop	string	Mendapatkan daftar item kerja dan tautan langsungnya.
tree	string	Mendapatkan pohon item kerja yang memperlihatkan hierarki tautan mereka.

Wiql

Kueri WIQL

Nama	Jenis	Deskripsi
query	string	Teks kueri WIQL

WorkItemFieldReference

Referensi ke bidang dalam item kerja

Nama	Jenis	Deskripsi
name	string	Nama bidang yang mudah diingat.
referenceName	string	Nama referensi bidang.
url	string	URL REST sumber daya.

WorkItemLink

Tautan antara dua item kerja.

Nama	Jenis	Deskripsi
rel	string	Jenis tautan.
source	WorkItemReference	Item kerja sumber.
target	WorkItemReference	Item pekerjaan target.

WorkItemQueryResult

Hasil kueri item kerja.

Nama	Jenis	Deskripsi
asOf	string	Tanggal kueri dijalankan dalam konteks.
columns	WorkItemFieldReference[]	Kolom kueri.
queryResultType	QueryResultType	Jenis hasil
queryType	QueryType	Jenis kueri
sortColumns	WorkItemQuerySortColumn[]	Kolom pengurutan kueri.
workItemRelations	WorkItemLink[]	Tautan item kerja yang dikembalikan oleh kueri.
workItems	WorkItemReference[]	Item kerja yang dikembalikan oleh kueri.

WorkItemQuerySortColumn

Kolom pengurutan.

Nama	Jenis	Deskripsi
descending	boolean	Arah untuk mengurutkan berdasar.
field	WorkItemFieldReference	Bidang item kerja.

WorkItemReference

Berisi referensi ke item kerja.

Nama	Jenis	Deskripsi
id	integer	ID item kerja.
url	string	URL REST API sumber daya

Bagikan melalui