Work Item Search Results - Fetch Work Item Search Results

Referenz

Dienst:: Search

API-Version:: 7.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

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" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name	Typ	Beschreibung
$orderBy	SortOption[]	Optionen zum Sortieren von Suchergebnissen. Wenn dieser Wert auf NULL festgelegt ist, werden die Ergebnisse nach Relevanz sortiert zurückgegeben. Wenn mehr als eine Sortieroption bereitgestellt wird, werden die Ergebnisse in der im OrderBy angegebenen Reihenfolge sortiert.
$skip	integer (int32)	Die Anzahl der Ergebnisse, die übersprungen werden sollen.
$top	integer (int32)	Anzahl der ergebnisse, die zurückgegeben werden sollen.
filters	object	Anzuwendende Filter. Legen Sie sie auf NULL fest, wenn keine Filter angewendet werden sollen.
includeFacets	boolean	Kennzeichnen, um sich für das Faceting im Ergebnis zu entscheiden. Das Standardverhalten ist "false".
searchText	string	Der Suchtext.

Antworten

Name	Typ	Beschreibung
200 OK	WorkItemSearchResponse	Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-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

Bereiche

Name	Beschreibung
vso.work	Gewährt die Möglichkeit, Arbeitsaufgaben, Abfragen, Boards, Flächen- und Iterationspfade und andere Metadaten zur Nachverfolgung von Arbeitsaufgaben zu lesen. Gewährt außerdem die Möglichkeit, Abfragen auszuführen, Arbeitsaufgaben zu durchsuchen und Benachrichtigungen über Arbeitsaufgabenereignisse über Dienst-Hooks zu erhalten.

Beispiele

Beispielanforderung

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
}

Beispiel für eine Antwort

Statuscode:: 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 werden soll.
WorkItemHit	Definiert die abgeglichenen Ausdrücke im Feld des Arbeitselementergebnisses.
WorkItemResult	Definiert das Arbeitselementergebnis, das einer Suchanforderung für Arbeitsaufgaben entspricht.
WorkItemSearchRequest	Definiert eine Suchanforderung für Arbeitsaufgaben.
WorkItemSearchResponse	Definiert ein Antwortelement, das für eine Suchanfrage für Arbeitsaufgaben zurückgegeben wird.

Project

Objekt

Definiert die Details des Projekts.

Name	Typ	Beschreibung
id	string (uuid)	ID des Projekts.
name	string	Name des Projekts.

SortOption

Objekt

Definiert, wie das Ergebnis sortiert werden soll.

Name	Typ	Beschreibung
field	string	Feldname, nach dem sortiert werden soll.
sortOrder	string	Reihenfolge (ASC/DESC), in der die Ergebnisse sortiert werden sollen.

WorkItemHit

Objekt

Definiert die abgeglichenen Ausdrücke im Feld des Arbeitselementergebnisses.

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

WorkItemResult

Objekt

Definiert das Arbeitselementergebnis, das einer Suchanforderung für Arbeitsaufgaben entspricht.

Name	Typ	Beschreibung
fields	object	Ein Standardsatz von Arbeitsaufgabenfeldern und deren Werten.
hits	WorkItemHit[]	Hervorgehobene Codeausschnitte von Feldern, die der Suchanforderung entsprechen. Die Liste wird nach Relevanz der Codeausschnitte sortiert.
project	Project	Projektdetails der Arbeitsaufgabe.
url	string	Verweis auf die Arbeitsaufgabe.

WorkItemSearchRequest

Objekt

Definiert eine Suchanforderung für Arbeitsaufgaben.

Name	Typ	Beschreibung
$orderBy	SortOption[]	Optionen zum Sortieren von Suchergebnissen. Wenn dieser Wert auf NULL festgelegt ist, werden die Ergebnisse nach Relevanz sortiert zurückgegeben. Wenn mehr als eine Sortieroption bereitgestellt wird, werden die Ergebnisse in der im OrderBy angegebenen Reihenfolge sortiert.
$skip	integer (int32)	Die Anzahl der Ergebnisse, die übersprungen werden sollen.
$top	integer (int32)	Anzahl der ergebnisse, die zurückgegeben werden sollen.
filters	object	Anzuwendende Filter. Legen Sie sie auf NULL fest, wenn keine Filter angewendet werden sollen.
includeFacets	boolean	Kennzeichnen, um sich für das Faceting im Ergebnis zu entscheiden. Das Standardverhalten ist "false".
searchText	string	Der Suchtext.

WorkItemSearchResponse

Objekt

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

Name	Typ	Beschreibung
count	integer (int32)	Die Gesamtanzahl der übereinstimmenen Arbeitsaufgaben.
facets	object	Ein Wörterbuch, das ein Array `Filter` Objekts für jedes Facet speichert.
infoCode	integer (int32)	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äfix-Wildcardabfrage nicht unterstützt, 5 - MultiWords mit code facet nicht unterstützt, 6 - Konto wird integriert, 7 - Konto wird integriert oder neu indiziert, 8 - Top-Wert gekürzt auf maximal zulässige Ergebnisse 9 - Verzweigungen 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 übereinstimmenen Arbeitsaufgaben.

Freigeben über

Work Item Search Results - Fetch Work Item Search Results

URI-Parameter

Anforderungstext

Antworten

Sicherheit

oauth2

Bereiche

Beispiele

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Project

SortOption

WorkItemHit

WorkItemResult

WorkItemSearchRequest

WorkItemSearchResponse

Zusätzliche Ressourcen