Work Item Search Results - Fetch Work Item Search Results

Başvuru

Hizmet:: Search

API Sürümü:: 7.1

Arama metni için bir sonuç kümesi sağlar.

POST https://almsearch.dev.azure.com/{organization}/{project}/_apis/search/workitemsearchresults?api-version=7.1

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ı
api-version	query	True	string	Kullanılacak API'nin sürümü. Bu, API'nin bu sürümünü kullanmak için '7.1' olarak ayarlanmalıdır.

İstek Gövdesi

Name	Tür	Description
$orderBy	SortOption[]	Arama sonuçlarını sıralama seçenekleri. Null olarak ayarlanırsa, sonuçlar ilgi düzeyine göre sıralanmış olarak döndürülür. Birden fazla sıralama seçeneği sağlanırsa, sonuçlar OrderBy'de belirtilen düzende sıralanır.
$skip	integer (int32)	Atlanacak sonuç sayısı.
$top	integer (int32)	Döndürülecek sonuç sayısı.
filters	object	Uygulanacak filtreler. Uygulanacak filtre yoksa null olarak ayarlayın.
includeFacets	boolean	Sonuçta yüz tanımayı tercih etmek için bayrak. Varsayılan davranış false'tur.
searchText	string	Arama metni.

Yanıtlar

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

Güvenlik

oauth2

Tür: oauth2
Akış: accessCode
Yetkilendirme URL’si: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Belirteç URL'si: 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

Kapsamlar

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, hizmet kancaları aracılığıyla sorgu yürütme, iş öğelerinde arama yapma ve iş öğesi olayları hakkında bildirim alma olanağı verir.

Örnekler

Örnek isteği

HTTP

POST https://almsearch.dev.azure.com/fabrikam/_apis/search/workitemsearchresults?api-version=7.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
}

Örnek yanıt

Durum kodu:: 200

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

Tanımlar

Name	Description
Project	Projenin ayrıntılarını tanımlar.
SortOption	Sonucun nasıl sıralanacağını tanımlar.
WorkItemHit	İş öğesi sonucunun alanındaki eşleşen terimleri tanımlar.
WorkItemResult	bir iş öğesi arama isteğiyle eşleşen iş öğesi sonucunu tanımlar.
WorkItemSearchRequest	bir iş öğesi arama isteği tanımlar.
WorkItemSearchResponse	İş öğesi arama isteği için döndürülen bir yanıt öğesini tanımlar.

Project

Object

Projenin ayrıntılarını tanımlar.

Name	Tür	Description
id	string (uuid)	Projenin kimliği.
name	string	Projenin adı.

SortOption

Object

Sonucun nasıl sıralanacağını tanımlar.

Name	Tür	Description
field	string	Sıralamanın yapılması gereken alan adı.
sortOrder	string	Sonuçların sıralanması gereken düzen (ASC/DESC).

WorkItemHit

Object

İş öğesi sonucunun alanındaki eşleşen terimleri tanımlar.

Name	Tür	Description
fieldReferenceName	string	Vurgulanan alanın başvuru adı.
highlights	string[]	Alanın eşleştirilen/vurgulanan kod parçacıkları.

WorkItemResult

Object

bir iş öğesi arama isteğiyle eşleşen iş öğesi sonucunu tanımlar.

Name	Tür	Description
fields	object	Standart bir iş öğesi alanı kümesi ve bunların değerleri.
hits	WorkItemHit[]	Arama isteğiyle eşleşen alanların kod parçacıkları vurgulandı. Liste, kod parçacıklarının ilgisine göre sıralanır.
project	Project	İş öğesinin proje ayrıntıları.
url	string	İş öğesine başvuru.

WorkItemSearchRequest

Object

bir iş öğesi arama isteği tanımlar.

Name	Tür	Description
$orderBy	SortOption[]	Arama sonuçlarını sıralama seçenekleri. Null olarak ayarlanırsa, sonuçlar ilgi düzeyine göre sıralanmış olarak döndürülür. Birden fazla sıralama seçeneği sağlanırsa, sonuçlar OrderBy'de belirtilen düzende sıralanır.
$skip	integer (int32)	Atlanacak sonuç sayısı.
$top	integer (int32)	Döndürülecek sonuç sayısı.
filters	object	Uygulanacak filtreler. Uygulanacak filtre yoksa null olarak ayarlayın.
includeFacets	boolean	Sonuçta yüz tanımayı tercih etmek için bayrak. Varsayılan davranış false'tur.
searchText	string	Arama metni.

WorkItemSearchResponse

Object

İş öğesi arama isteği için döndürülen bir yanıt öğesini tanımlar.

Name	Tür	Description
count	integer (int32)	Eşleşen iş öğelerinin toplam sayısı.
facets	object	Her modelde bir dizi `Filter` nesnesi depolar.
infoCode	integer (int32)	Ek bilgileri gösteren sayısal kod: 0 - Tamam, 1 - Hesap yeniden dizinleniyor, 2 - Hesap dizin oluşturma başlatılmadı, 3 - Geçersiz İstek, 4 - Ön ek joker karakter sorgusu desteklenmiyor, 5 - Kod modelli MultiWords desteklenmiyor, 6 - Hesap ekleniyor, 7 - Hesap ekleniyor veya yeniden dizinleniyor, 8 - En yüksek değer maxresult izin verilen 9'a kırpılıyor - Dallar dizinleniyor, 10 - Model oluşturma etkin değil, 11 - İş öğeleri erişilebilir değil, 19 - Kod türü filtreleri desteklenmeyen tümcecik sorguları, 20 - Kod türü filtreleri desteklenmeyen joker karakter sorguları. Diğer tüm bilgi kodları iç amaçla kullanılır.
results	WorkItemResult[]	En çok eşleşen iş öğelerinin listesi.