Work Item Search Results - Fetch Work Item Search Results

Riferimento

Service:: Search

API Version:: 7.1-preview.1

Fornisce un set di risultati per il testo di ricerca.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
project	path		string	ID progetto o nome del progetto
api-version	query	True	string	Versione dell'API da usare. Deve essere impostato su '7.1-preview.1' per usare questa versione dell'API.

Corpo della richiesta

Nome	Tipo	Descrizione
$orderBy	SortOption[]	Opzioni per l'ordinamento dei risultati della ricerca. Se impostato su Null, i risultati verranno restituiti ordinati in base alla pertinenza. Se vengono fornite più opzioni di ordinamento, i risultati vengono ordinati nell'ordine specificato in OrderBy.
$skip	integer	Numero di risultati da ignorare.
$top	integer	Numero di risultati da restituire.
filters	object	Filtri da applicare. Impostarlo su Null se non sono presenti filtri da applicare.
includeFacets	boolean	Flag per scegliere il faceting nel risultato. Il comportamento predefinito è false.
searchText	string	Testo di ricerca.

Risposte

Nome	Tipo	Descrizione
200 OK	WorkItemSearchResponse	operazione riuscita

Sicurezza

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

Nome	Descrizione
vso.work	Concede la possibilità di leggere elementi di lavoro, query, bacheche, percorsi di aree e iterazioni e altri metadati correlati al rilevamento degli elementi di lavoro. Concede inoltre la possibilità di eseguire query, cercare elementi di lavoro e ricevere notifiche sugli eventi degli elementi di lavoro tramite hook del servizio.

Esempio

Sample Request

HTTP

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

Status code:: 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
      }
    ]
  }
}

Definizioni

Nome	Descrizione
Project	Definisce i dettagli del progetto.
SortOption	Definisce come ordinare il risultato.
WorkItemHit	Definisce i termini corrispondenti nel campo del risultato dell'elemento di lavoro.
WorkItemResult	Definisce il risultato dell'elemento di lavoro corrispondente a una richiesta di ricerca dell'elemento di lavoro.
WorkItemSearchRequest	Definisce una richiesta di ricerca degli elementi di lavoro.
WorkItemSearchResponse	Definisce un elemento di risposta restituito per una richiesta di ricerca degli elementi di lavoro.

Project

Definisce i dettagli del progetto.

Nome	Tipo	Descrizione
id	string	ID del progetto.
name	string	Nome del progetto.

SortOption

Definisce come ordinare il risultato.

Nome	Tipo	Descrizione
field	string	Nome del campo in base al quale eseguire l'ordinamento.
sortOrder	string	Ordine (ASC/DESC) in cui devono essere ordinati i risultati.

WorkItemHit

Definisce i termini corrispondenti nel campo del risultato dell'elemento di lavoro.

Nome	Tipo	Descrizione
fieldReferenceName	string	Nome di riferimento del campo evidenziato.
highlights	string[]	Frammenti corrispondenti/evidenziati del campo.

WorkItemResult

Definisce il risultato dell'elemento di lavoro corrispondente a una richiesta di ricerca dell'elemento di lavoro.

Nome	Tipo	Descrizione
fields	object	Un set standard di campi dell'elemento di lavoro e i relativi valori.
hits	WorkItemHit[]	Frammenti di campi evidenziati che corrispondono alla richiesta di ricerca. L'elenco viene ordinato in base alla pertinenza dei frammenti di codice.
project	Project	Dettagli del progetto dell'elemento di lavoro.
url	string	Riferimento all'elemento di lavoro.

WorkItemSearchRequest

Definisce una richiesta di ricerca degli elementi di lavoro.

Nome	Tipo	Descrizione
$orderBy	SortOption[]	Opzioni per l'ordinamento dei risultati della ricerca. Se impostato su Null, i risultati verranno restituiti ordinati in base alla pertinenza. Se vengono fornite più opzioni di ordinamento, i risultati vengono ordinati nell'ordine specificato in OrderBy.
$skip	integer	Numero di risultati da ignorare.
$top	integer	Numero di risultati da restituire.
filters	object	Filtri da applicare. Impostarlo su Null se non sono presenti filtri da applicare.
includeFacets	boolean	Flag per scegliere il faceting nel risultato. Il comportamento predefinito è false.
searchText	string	Testo di ricerca.

WorkItemSearchResponse

Definisce un elemento di risposta restituito per una richiesta di ricerca degli elementi di lavoro.

Nome	Tipo	Descrizione
count	integer	Numero totale di elementi di lavoro corrispondenti.
facets	object	Dizionario che archivia una matrice di `Filter` oggetti in base a ogni facet.
infoCode	integer	Codice numerico che indica eventuali informazioni aggiuntive: 0 - Ok, 1 - Account in fase di reindicizzazione, 2 - L'indicizzazione dell'account non è stata avviata, 3 - Richiesta non valida, 4 - Query con caratteri jolly con prefisso non supportato, 5 - MultiWords con facet di codice non supportato, 6 - L'account viene eseguito l'onboarding o la reindicizzazione dell'account, 8 - Valore superiore tagliato a maxresult consentito 9 - I rami vengono indicizzati, 10 - Facet non abilitato, 11 - Elementi di lavoro non accessibili, 19 - Query di frasi con filtri di tipo di codice non supportati, 20 - Query con caratteri jolly con filtri di tipo di codice non supportati. Qualsiasi altro codice informativo viene usato a scopo interno.
results	WorkItemResult[]	Elenco di elementi di lavoro corrispondenti principali.