Work Item Search Results - Fetch Work Item Search Results
Menyediakan serangkaian hasil untuk teks pencarian.
POST https://almsearch.dev.azure.com/{organization}/{project}/_apis/search/workitemsearchresults?api-version=7.1-preview.1
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
organization
|
path | True |
string |
Nama organisasi Azure DevOps. |
project
|
path |
string |
ID proyek atau nama proyek |
|
api-version
|
query | True |
string |
Versi API yang akan digunakan. Ini harus diatur ke '7.1-preview.1' untuk menggunakan versi api ini. |
Isi Permintaan
Nama | Jenis | Deskripsi |
---|---|---|
$orderBy |
Opsi untuk mengurutkan hasil pencarian. Jika diatur ke null, hasilnya akan dikembalikan diurutkan berdasarkan relevansi. Jika tersedia lebih dari satu opsi pengurutan, hasilnya diurutkan dalam urutan yang ditentukan dalam OrderBy. |
|
$skip |
integer |
Jumlah hasil yang akan dilewati. |
$top |
integer |
Jumlah hasil yang akan dikembalikan. |
filters |
object |
Filter yang akan diterapkan. Atur ke null jika tidak ada filter yang akan diterapkan. |
includeFacets |
boolean |
Bendera untuk memilih faset dalam hasil. Perilaku default adalah false. |
searchText |
string |
Teks pencarian. |
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 perulangan dan area, serta 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
Sample Request
POST https://almsearch.dev.azure.com/fabrikam/_apis/search/workitemsearchresults?api-version=7.1-preview.1
{
"searchText": "Rest Api Story",
"$skip": 0,
"$top": 1,
"filters": {
"System.TeamProject": [
"MyFirstProject"
],
"System.AreaPath": [
"MyFirstProject"
],
"System.WorkItemType": [
"Bug",
"User Story",
"Feature",
"Task"
],
"System.State": [
"New",
"Active",
"Closed"
],
"System.AssignedTo": [
"John Doe <jodoe@microsoft.com>"
]
},
"$orderBy": [
{
"field": "system.id",
"sortOrder": "ASC"
}
],
"includeFacets": true
}
Sample Response
{
"count": 2,
"results": [
{
"project": {
"name": "MyFirstProject",
"id": "5a0690b2-823c-4389-a3ab-5ea2a9cbde75"
},
"fields": {
"system.id": "2",
"system.workitemtype": "User Story",
"system.title": "Rest Api User Story",
"system.assignedto": "John Doe <jodoe@microsoft.com>",
"system.state": "Closed",
"system.tags": "api; rest",
"system.rev": "5",
"system.createddate": "2018-01-05T17:14:40.033Z",
"system.changeddate": "2018-01-05T17:55:36.953Z"
},
"hits": [
{
"fieldReferenceName": "system.tags",
"highlights": [
"<highlighthit>api</highlighthit>; <highlighthit>rest</highlighthit>"
]
},
{
"fieldReferenceName": "system.title",
"highlights": [
"<highlighthit>Rest</highlighthit> <highlighthit>Api</highlighthit> User <highlighthit>Story</highlighthit>"
]
}
],
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/2"
}
],
"infoCode": 0,
"facets": {
"System.TeamProject": [
{
"name": "MyFirstProject",
"id": "MyFirstProject",
"resultCount": 2
}
],
"System.WorkItemType": [
{
"name": "Task",
"id": "Task",
"resultCount": 1
},
{
"name": "User Story",
"id": "User Story",
"resultCount": 1
},
{
"name": "Bug",
"id": "Bug",
"resultCount": 0
},
{
"name": "Feature",
"id": "Feature",
"resultCount": 0
}
],
"System.State": [
{
"name": "Closed",
"id": "Closed",
"resultCount": 1
},
{
"name": "New",
"id": "New",
"resultCount": 1
},
{
"name": "Active",
"id": "Active",
"resultCount": 0
}
],
"System.AssignedTo": [
{
"name": "John Doe <jodoe@microsoft.com>",
"id": "John Doe <jodoe@microsoft.com>",
"resultCount": 2
}
]
}
}
Definisi
Nama | Deskripsi |
---|---|
Project |
Menentukan detail proyek. |
Sort |
Menentukan cara mengurutkan hasilnya. |
Work |
Menentukan istilah yang cocok di bidang hasil item kerja. |
Work |
Menentukan hasil item kerja yang cocok dengan permintaan pencarian item kerja. |
Work |
Menentukan permintaan pencarian item kerja. |
Work |
Menentukan item respons yang dikembalikan untuk permintaan pencarian item kerja. |
Project
Menentukan detail proyek.
Nama | Jenis | Deskripsi |
---|---|---|
id |
string |
Id proyek. |
name |
string |
Nama proyek. |
SortOption
Menentukan cara mengurutkan hasilnya.
Nama | Jenis | Deskripsi |
---|---|---|
field |
string |
Nama bidang di mana pengurutan harus dilakukan. |
sortOrder |
string |
Urutan (ASC/DESC) tempat hasil harus diurutkan. |
WorkItemHit
Menentukan istilah yang cocok di bidang hasil item kerja.
Nama | Jenis | Deskripsi |
---|---|---|
fieldReferenceName |
string |
Nama referensi bidang yang disorot. |
highlights |
string[] |
Cuplikan bidang yang cocok/disorot. |
WorkItemResult
Menentukan hasil item kerja yang cocok dengan permintaan pencarian item kerja.
Nama | Jenis | Deskripsi |
---|---|---|
fields |
object |
Sekumpulan bidang item kerja standar dan nilainya. |
hits |
Cuplikan bidang yang disorot yang cocok dengan permintaan pencarian. Daftar diurutkan berdasarkan relevansi cuplikan. |
|
project |
Detail proyek item kerja. |
|
url |
string |
Referensi ke item kerja. |
WorkItemSearchRequest
Menentukan permintaan pencarian item kerja.
Nama | Jenis | Deskripsi |
---|---|---|
$orderBy |
Opsi untuk mengurutkan hasil pencarian. Jika diatur ke null, hasilnya akan dikembalikan diurutkan berdasarkan relevansi. Jika tersedia lebih dari satu opsi pengurutan, hasilnya diurutkan dalam urutan yang ditentukan dalam OrderBy. |
|
$skip |
integer |
Jumlah hasil yang akan dilewati. |
$top |
integer |
Jumlah hasil yang akan dikembalikan. |
filters |
object |
Filter yang akan diterapkan. Atur ke null jika tidak ada filter yang akan diterapkan. |
includeFacets |
boolean |
Bendera untuk memilih faset dalam hasil. Perilaku default adalah false. |
searchText |
string |
Teks pencarian. |
WorkItemSearchResponse
Menentukan item respons yang dikembalikan untuk permintaan pencarian item kerja.
Nama | Jenis | Deskripsi |
---|---|---|
count |
integer |
Jumlah total item kerja yang cocok. |
facets |
object |
Kamus yang menyimpan array |
infoCode |
integer |
Kode numerik yang menunjukkan informasi tambahan: 0 - Ok, 1 - Akun sedang diindeks ulang, 2 - Pengindeksan akun belum dimulai, 3 - Permintaan Tidak Valid, 4 - Kueri kartubebas awalan tidak didukung, 5 - MultiWords dengan faset kode tidak didukung, 6 - Akun sedang di-onboarding, 7 - Akun sedang di-onboarding atau diindeks ulang, 8 - Nilai teratas dipangkas ke maxresult yang diizinkan 9 - Cabang sedang diindeks, 10 - Faset tidak diaktifkan, 11 - Item kerja tidak dapat diakses, 19 - Kueri frasa dengan filter jenis kode tidak didukung, 20 - Kueri wildcard dengan filter jenis kode tidak didukung. Kode info lainnya digunakan untuk tujuan internal. |
results |
Daftar item kerja teratas yang cocok. |