Queries - Search Queries
Mencari semua kueri yang dapat diakses pengguna dalam proyek saat ini
GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries?$filter={$filter}&api-version=7.1-preview.2
GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries?$filter={$filter}&$top={$top}&$expand={$expand}&$includeDeleted={$includeDeleted}&api-version=7.1-preview.2
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
organization
|
path | True |
string |
Nama organisasi Azure DevOps. |
project
|
path | True |
string |
ID proyek atau nama proyek |
$filter
|
query | True |
string |
Teks untuk memfilter kueri. |
api-version
|
query | True |
string |
Versi API yang akan digunakan. Ini harus diatur ke '7.1-preview.2' untuk menggunakan versi api ini. |
$expand
|
query | |||
$include
|
query |
boolean |
Sertakan kueri dan folder yang dihapus |
|
$top
|
query |
integer int32 |
Jumlah kueri yang akan dikembalikan (Defaultnya adalah 50 dan maksimum adalah 200). |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
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. |
Definisi
Nama | Deskripsi |
---|---|
Identity |
Menjelaskan referensi ke identitas. |
Link |
Mode kueri tautan. |
Logical |
Operator logika yang memisahkan klausa kondisi |
Query |
Parameter perluas untuk kueri. Opsi yang mungkin adalah { None, Wiql, Clauses, All, Minimal } |
Query |
Mewakili item dalam hierarki kueri item kerja. Ini bisa berupa kueri atau folder. |
Query |
|
Query |
Opsi rekursi untuk digunakan dalam kueri pohon. |
Query |
Jenis kueri. |
Reference |
Kelas untuk mewakili kumpulan tautan referensi REST. |
Work |
Menjelaskan operasi bidang item kerja. |
Work |
Referensi ke bidang dalam item kerja |
Work |
Mewakili klausa dalam kueri item kerja. Ini memperlihatkan struktur kueri item kerja. |
Work |
Kolom pengurutan. |
IdentityReference
Menjelaskan referensi ke identitas.
Nama | Jenis | Deskripsi |
---|---|---|
_links |
Bidang ini berisi nol atau lebih tautan menarik tentang subjek grafik. Tautan ini dapat dipanggil untuk mendapatkan hubungan tambahan atau informasi lebih rinci tentang subjek grafik ini. |
|
descriptor |
string |
Deskriptor adalah cara utama untuk mereferensikan subjek grafik saat sistem berjalan. Bidang ini akan secara unik mengidentifikasi subjek grafik yang sama di seluruh Akun dan Organisasi. |
directoryAlias |
string |
Tidak digunakan lagi - Dapat diambil dengan mengkueri pengguna Graph yang direferensikan dalam entri "mandiri" kamus IdentityRef "_links" |
displayName |
string |
Ini adalah nama tampilan subjek grafik yang tidak unik. Untuk mengubah bidang ini, Anda harus mengubah nilainya di penyedia sumber. |
id |
string |
|
imageUrl |
string |
Tidak digunakan lagi - Tersedia dalam entri "avatar" kamus IdentityRef "_links" |
inactive |
boolean |
Tidak digunakan lagi - Dapat diambil dengan mengkueri status keanggotaan Graph yang direferensikan dalam entri "membershipState" dari kamus "_links" GraphUser |
isAadIdentity |
boolean |
Tidak digunakan lagi - Dapat disimpulkan dari jenis subjek deskriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
isContainer |
boolean |
Tidak digunakan lagi - Dapat disimpulkan dari jenis subjek deskriptor (Descriptor.IsGroupType) |
isDeletedInOrigin |
boolean |
|
name |
string |
Properti back-compat warisan. Ini telah menjadi nilai spesifik WIT dari Konstanta. Akan disembunyikan (tetapi ada) pada klien kecuali mereka menargetkan versi terbaru |
profileUrl |
string |
Tidak digunakan lagi - tidak digunakan dalam sebagian besar implementasi ToIdentityRef yang sudah ada sebelumnya |
uniqueName |
string |
Tidak digunakan lagi - gunakan Domain+PrincipalName sebagai gantinya |
url |
string |
Url ini adalah rute lengkap ke sumber daya sumber subjek grafik ini. |
LinkQueryMode
Mode kueri tautan.
Nama | Jenis | Deskripsi |
---|---|---|
linksOneHopDoesNotContain |
string |
Mengembalikan item kerja yang memenuhi sumber, hanya jika tidak ada item kerja tertaut yang memenuhi kriteria tautan dan target. |
linksOneHopMayContain |
string |
Mengembalikan item kerja yang memenuhi kriteria sumber dan tautan, meskipun tidak ada item kerja tertaut yang memenuhi kriteria target. |
linksOneHopMustContain |
string |
Mengembalikan item kerja di mana semua kriteria sumber, target, dan tautan terpenuhi. |
linksRecursiveDoesNotContain |
string |
|
linksRecursiveMayContain |
string |
Mengembalikan item kerja hierarki item kerja yang secara default memenuhi sumber |
linksRecursiveMustContain |
string |
|
workItems |
string |
Mengembalikan daftar datar item kerja. |
LogicalOperation
Operator logika yang memisahkan klausa kondisi
Nama | Jenis | Deskripsi |
---|---|---|
and |
string |
|
none |
string |
|
or |
string |
QueryExpand
Parameter perluas untuk kueri. Opsi yang mungkin adalah { None, Wiql, Clauses, All, Minimal }
Nama | Jenis | Deskripsi |
---|---|---|
all |
string |
Memperluas semua properti |
clauses |
string |
Memperluas Kolom, Tautan, ChangeInfo, teks dan klausa WIQL |
minimal |
string |
Menampilkan properti minimal dan teks WIQL |
none |
string |
Memperluas Kolom, Tautan, dan ChangeInfo |
wiql |
string |
Memperluas teks Kolom, Tautan, ChangeInfo, dan WIQL |
QueryHierarchyItem
Mewakili item dalam hierarki kueri item kerja. Ini bisa berupa kueri atau folder.
Nama | Jenis | Deskripsi |
---|---|---|
_links |
Menautkan referensi ke sumber daya REST terkait. |
|
children |
Item kueri anak di dalam folder kueri. |
|
clauses |
Klausa untuk kueri datar. |
|
columns |
Kolom kueri. |
|
createdBy |
Identitas yang membuat item kueri. |
|
createdDate |
string |
Saat item kueri dibuat. |
filterOptions |
Mode kueri tautan. |
|
hasChildren |
boolean |
Jika ini adalah folder kueri, menunjukkan apakah folder tersebut berisi turunan. |
id |
string |
Id item kueri. |
isDeleted |
boolean |
Menunjukkan apakah item kueri ini dihapus. Mengatur ini ke false pada item kueri yang dihapus akan membatalkan penghapusannya. Membatalkan penghapusan kueri atau folder tidak akan mengembalikan perubahan izin yang sebelumnya diterapkan padanya. |
isFolder |
boolean |
Menunjukkan apakah ini adalah folder kueri atau kueri. |
isInvalidSyntax |
boolean |
Menunjukkan apakah WIQL kueri ini tidak valid. Ini bisa disebabkan oleh sintaks yang tidak valid atau jalur area/iterasi yang tidak lagi valid. |
isPublic |
boolean |
Menunjukkan apakah item kueri ini bersifat publik atau privat. |
lastExecutedBy |
Identitas yang terakhir menjalankan kueri. |
|
lastExecutedDate |
string |
Saat kueri terakhir dijalankan. |
lastModifiedBy |
Identitas yang terakhir mengubah item kueri. |
|
lastModifiedDate |
string |
Ketika item kueri terakhir diubah. |
linkClauses |
Klausa kueri tautan. |
|
name |
string |
Nama item kueri. |
path |
string |
Jalur item kueri. |
queryRecursionOption |
Opsi rekursi untuk digunakan dalam kueri pohon. |
|
queryType |
Jenis kueri. |
|
sortColumns |
Kolom pengurutan kueri. |
|
sourceClauses |
Klausa sumber dalam kueri tautan pohon atau satu hop. |
|
targetClauses |
Klausa target dalam kueri tautan pohon atau satu hop. |
|
url |
string |
|
wiql |
string |
Teks WIQL kueri |
QueryHierarchyItemsResult
Nama | Jenis | Deskripsi |
---|---|---|
count |
integer |
Jumlah item. |
hasMore |
boolean |
Menunjukkan apakah batas pengembalian maksimum terpukul tetapi masih ada lebih banyak item |
value |
Daftar item |
QueryRecursionOption
Opsi rekursi untuk digunakan dalam kueri pohon.
Nama | Jenis | Deskripsi |
---|---|---|
childFirst |
string |
Mengembalikan item kerja yang memenuhi kriteria target, meskipun tidak ada item kerja yang memenuhi kriteria sumber dan tautan. |
parentFirst |
string |
Mengembalikan item kerja yang memenuhi sumber, meskipun tidak ada item kerja tertaut yang memenuhi kriteria target dan tautan. |
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. |
ReferenceLinks
Kelas untuk mewakili kumpulan tautan referensi REST.
Nama | Jenis | Deskripsi |
---|---|---|
links |
object |
Tampilan baca-saja dari tautan. Karena tautan Referensi bersifat baca-saja, kami hanya ingin mengeksposnya sebagai baca saja. |
WorkItemFieldOperation
Menjelaskan operasi bidang item kerja.
Nama | Jenis | Deskripsi |
---|---|---|
name |
string |
Nama operasi yang mudah diingat. |
referenceName |
string |
Nama referensi operasi. |
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. |
WorkItemQueryClause
Mewakili klausa dalam kueri item kerja. Ini memperlihatkan struktur kueri item kerja.
Nama | Jenis | Deskripsi |
---|---|---|
clauses |
Klausa anak jika klausul saat ini adalah operator logis |
|
field |
Bidang yang terkait dengan kondisi |
|
fieldValue |
Sisi kanan kondisi saat perbandingan bidang ke bidang |
|
isFieldValue |
boolean |
Menentukan apakah ini adalah perbandingan bidang ke bidang |
logicalOperator |
Operator logika yang memisahkan klausa kondisi |
|
operator |
Operator bidang |
|
value |
string |
Sisi kanan kondisi saat perbandingan bidang ke nilai |
WorkItemQuerySortColumn
Kolom pengurutan.
Nama | Jenis | Deskripsi |
---|---|---|
descending |
boolean |
Arah untuk mengurutkan berdasar. |
field |
Bidang item kerja. |