Work Item Search Results - Fetch Work Item Search Results

Referenz

Service:: Search

API Version:: 7.1-preview.1

Stellt eine Reihe von Ergebnissen für den Suchtext bereit.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
project	path		string	Projekt-ID oder Projektname
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1-preview.1" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name	Typ	Beschreibung
$orderBy	SortOption[]	Optionen zum Sortieren von Suchergebnissen. Wenn sie auf NULL festgelegt sind, werden die Ergebnisse nach Relevanz sortiert zurückgegeben. Wenn mehrere Sortieroptionen bereitgestellt werden, werden die Ergebnisse in der in OrderBy angegebenen Reihenfolge sortiert.
$skip	integer	Anzahl der zu überspringenden Ergebnisse.
$top	integer	Anzahl der zurückgegebenen Ergebnisse.
filters	object	Anzuwendende Filter. Legen Sie sie auf NULL fest, wenn keine Filter angewendet werden müssen.
includeFacets	boolean	Kennzeichnen, um sich für eine Facetierung im Ergebnis zu entscheiden. Das Standardverhalten ist false.
searchText	string	Der Suchtext.

Antworten

Name	Typ	Beschreibung
200 OK	WorkItemSearchResponse	Erfolgreicher Vorgang

Sicherheit

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

Name	Beschreibung
vso.work	Ermöglicht das Lesen von Arbeitselementen, Abfragen, Boards, Bereichs- und Iterationspfaden und anderen Metadaten zur Nachverfolgung von Arbeitselementen. Außerdem können Sie Abfragen ausführen, Arbeitselemente durchsuchen und Benachrichtigungen über Arbeitselementereignisse über Diensthaken empfangen.

Beispiele

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

Definitionen

Name	Beschreibung
Project	Definiert die Details des Projekts.
SortOption	Definiert, wie das Ergebnis sortiert wird.
WorkItemHit	Definiert die abgeglichenen Begriffe im Feld des Arbeitselementergebnisses.
WorkItemResult	Definiert das Arbeitselementergebnis, das einer Arbeitselementsuchanforderung entspricht.
WorkItemSearchRequest	Definiert eine Arbeitselementsuchanforderung.
WorkItemSearchResponse	Definiert ein Antwortelement, das für eine Arbeitselementsuchanforderung zurückgegeben wird.

Project

Definiert die Details des Projekts.

Name	Typ	Beschreibung
id	string	Id des Projekts.
name	string	Der Name des Projekts.

SortOption

Definiert, wie das Ergebnis sortiert wird.

Name	Typ	Beschreibung
field	string	Feldname, für den die Sortierung erfolgen soll.
sortOrder	string	Reihenfolge (ASC/DESC), in der die Ergebnisse sortiert werden sollen.

WorkItemHit

Definiert die abgeglichenen Begriffe im Feld des Arbeitselementergebnisses.

Name	Typ	Beschreibung
fieldReferenceName	string	Verweisname des hervorgehobenen Felds.
highlights	string[]	Übereinstimmend/hervorgehobene Codeausschnitte des Felds.

WorkItemResult

Definiert das Arbeitselementergebnis, das einer Arbeitselementsuchanforderung entspricht.

Name	Typ	Beschreibung
fields	object	Ein Standardsatz von Arbeitselementfeldern und deren Werte.
hits	WorkItemHit[]	Hervorgehobene Ausschnitte von Feldern, die der Suchanforderung entsprechen. Die Liste ist nach der Relevanz der Codeausschnitte sortiert.
project	Project	Projektdetails des Arbeitselements.
url	string	Verweis auf das Arbeitselement.

WorkItemSearchRequest

Definiert eine Arbeitselementsuchanforderung.

Name	Typ	Beschreibung
$orderBy	SortOption[]	Optionen zum Sortieren von Suchergebnissen. Wenn sie auf NULL festgelegt sind, werden die Ergebnisse nach Relevanz sortiert zurückgegeben. Wenn mehrere Sortieroptionen bereitgestellt werden, werden die Ergebnisse in der in OrderBy angegebenen Reihenfolge sortiert.
$skip	integer	Anzahl der zu überspringenden Ergebnisse.
$top	integer	Anzahl der zurückgegebenen Ergebnisse.
filters	object	Anzuwendende Filter. Legen Sie sie auf NULL fest, wenn keine Filter angewendet werden müssen.
includeFacets	boolean	Kennzeichnen, um sich für eine Facetierung im Ergebnis zu entscheiden. Das Standardverhalten ist false.
searchText	string	Der Suchtext.

WorkItemSearchResponse

Definiert ein Antwortelement, das für eine Arbeitselementsuchanforderung zurückgegeben wird.

Name	Typ	Beschreibung
count	integer	Gesamtanzahl der abgeglichenen Arbeitselemente.
facets	object	Ein Wörterbuch, das ein Objektarray `Filter` für jedes Facet speichert.
infoCode	integer	Numerischer Code, der alle zusätzlichen Informationen angibt: 0 – Ok, 1 – Konto wird neu indiziert, 2 - Kontoindizierung wurde nicht gestartet, 3 - Ungültige Anforderung, 4 - Präfixplatzhalterabfrage nicht unterstützt, 5 - MultiWords mit Codefacet nicht unterstützt, 6 - Konto wird integriert, 7 - Konto wird integriert oder neu indiziert, 8 - Top-Wert auf maximal zulässige Ergebnisse gekürzt 9 - Branches werden indiziert, 10 – Faceting nicht aktiviert, 11 – Arbeitselemente nicht zugänglich, 19 – Ausdrucksabfragen mit Codetypfiltern nicht unterstützt, 20 – Wildcardabfragen mit Codetypfiltern nicht unterstützt. Jeder andere Infocode wird für interne Zwecke verwendet.
results	WorkItemResult[]	Liste der am häufigsten übereinstimmend zugeordneten Arbeitselemente.

Freigeben über