Work Item Search Results - Fetch Work Item Search Results

Odwołanie

Usługa:: Search

Wersja interfejsu API:: 7.1

Zawiera zestaw wyników dla tekstu wyszukiwania.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
project	path		string	Identyfikator projektu lub nazwa projektu
api-version	query	True	string	Wersja interfejsu API do użycia. Należy ustawić wartość "7.1", aby używać tej wersji interfejsu API.

Treść żądania

Nazwa	Typ	Opis
$orderBy	SortOption[]	Opcje sortowania wyników wyszukiwania. Jeśli zostanie ustawiona wartość null, wyniki zostaną zwrócone posortowane według istotności. Jeśli podano więcej niż jedną opcję sortowania, wyniki są sortowane w kolejności określonej w kolumnie OrderBy.
$skip	integer (int32)	Liczba wyników do pominięcia.
$top	integer (int32)	Liczba wyników do zwrócenia.
filters	object	Filtry do zastosowania. Ustaw wartość null, jeśli nie ma żadnych filtrów do zastosowania.
includeFacets	boolean	Flaga, aby wybrać aspektowanie w wyniku. Domyślne zachowanie to fałsz.
searchText	string	Tekst wyszukiwania.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	WorkItemSearchResponse	operacja zakończona powodzeniem

Zabezpieczenia

oauth2

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Adres URL tokenu: 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

Zakresy

Nazwa	Opis
vso.work	Umożliwia odczytywanie elementów roboczych, zapytań, tablic, ścieżek obszaru i iteracji oraz innych metadanych powiązanych ze śledzeniem elementów roboczych. Ponadto umożliwia wykonywanie zapytań, wyszukiwanie elementów roboczych i odbieranie powiadomień o zdarzeniach elementów roboczych za pośrednictwem punktów zaczepienia usługi.

Przykłady

Przykładowe żądanie

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
}

Przykładowa odpowiedź

Kod stanu:: 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
      }
    ]
  }
}

Definicje

Nazwa	Opis
Project	Definiuje szczegóły projektu.
SortOption	Definiuje sposób sortowania wyniku.
WorkItemHit	Definiuje dopasowane terminy w polu wyniku elementu roboczego.
WorkItemResult	Definiuje wynik elementu roboczego pasujący do żądania wyszukiwania elementu roboczego.
WorkItemSearchRequest	Definiuje żądanie wyszukiwania elementów roboczych.
WorkItemSearchResponse	Definiuje element odpowiedzi zwracany dla żądania wyszukiwania elementu roboczego.

Project

Objekt

Definiuje szczegóły projektu.

Nazwa	Typ	Opis
id	string (uuid)	Identyfikator projektu.
name	string	Nazwa projektu.

SortOption

Objekt

Definiuje sposób sortowania wyniku.

Nazwa	Typ	Opis
field	string	Nazwa pola, w którym należy przeprowadzić sortowanie.
sortOrder	string	Kolejność (ASC/DESC), w której wyniki powinny być sortowane.

WorkItemHit

Objekt

Definiuje dopasowane terminy w polu wyniku elementu roboczego.

Nazwa	Typ	Opis
fieldReferenceName	string	Nazwa odwołania do wyróżnionego pola.
highlights	string[]	Dopasowane/wyróżnione fragmenty pola.

WorkItemResult

Objekt

Definiuje wynik elementu roboczego pasujący do żądania wyszukiwania elementu roboczego.

Nazwa	Typ	Opis
fields	object	Standardowy zestaw pól elementów roboczych i ich wartości.
hits	WorkItemHit[]	Wyróżnione fragmenty pól pasujących do żądania wyszukiwania. Lista jest sortowana według istotności fragmentów kodu.
project	Project	Szczegóły projektu elementu roboczego.
url	string	Odwołanie do elementu roboczego.

WorkItemSearchRequest

Objekt

Definiuje żądanie wyszukiwania elementów roboczych.

Nazwa	Typ	Opis
$orderBy	SortOption[]	Opcje sortowania wyników wyszukiwania. Jeśli zostanie ustawiona wartość null, wyniki zostaną zwrócone posortowane według istotności. Jeśli podano więcej niż jedną opcję sortowania, wyniki są sortowane w kolejności określonej w kolumnie OrderBy.
$skip	integer (int32)	Liczba wyników do pominięcia.
$top	integer (int32)	Liczba wyników do zwrócenia.
filters	object	Filtry do zastosowania. Ustaw wartość null, jeśli nie ma żadnych filtrów do zastosowania.
includeFacets	boolean	Flaga, aby wybrać aspektowanie w wyniku. Domyślne zachowanie to fałsz.
searchText	string	Tekst wyszukiwania.

WorkItemSearchResponse

Objekt

Definiuje element odpowiedzi zwracany dla żądania wyszukiwania elementu roboczego.

Nazwa	Typ	Opis
count	integer (int32)	Łączna liczba dopasowanych elementów roboczych.
facets	object	Słownik przechowującą tablicę obiektów `Filter` względem każdego aspektu.
infoCode	integer (int32)	Kod liczbowy wskazujący dodatkowe informacje: 0 — Ok, 1 — Konto jest ponownie indeksowane, 2 — Indeksowanie konta nie zostało uruchomione, 3 — Nieprawidłowe żądanie, 4 — Kwerenda wieloznaczna prefiksu nie jest obsługiwana, 5 — MultiWords z nieobsługiwanym aspektem kodu, 6 — Konto jest dołączane, 7 — Konto jest dołączane lub ponownie indeksowane, 8 — maksymalna wartość przycinana do maksymalnego dozwolonego 9 — Gałęzie są indeksowane, 10 — Nie włączono tworzenia aspektów, 11 — elementy robocze nie są dostępne, 19 — zapytania fraz z filtrami typów kodu nieobsługiwane, 20 — zapytania wieloznaczne z filtrami typu kodu nieobsługiwane. Każdy inny kod informacyjny jest używany do celów wewnętrznych.
results	WorkItemResult[]	Lista najlepiej dopasowanych elementów roboczych.

Udostępnij za pośrednictwem

Work Item Search Results - Fetch Work Item Search Results

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

oauth2

Zakresy

Przykłady

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Project

SortOption

WorkItemHit

WorkItemResult

WorkItemSearchRequest

WorkItemSearchResponse

Dodatkowe zasoby