Code Search Results - Fetch Code 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/codesearchresults?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".
includeSnippet	boolean	Kennzeichnen, um sich für das Einschließen eines übereinstimmenden Codeausschnitts in das Ergebnis zu entscheiden. Das Standardverhalten ist "false".
searchText	string	Der Suchtext.

Antworten

Name	Typ	Beschreibung
200 OK	CodeSearchResponse	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.code	Gewährt die Möglichkeit, Quellcode und Metadaten zu Commits, Changesets, Verzweigungen und anderen Versionskontrollartefakten zu lesen. Gewährt außerdem die Möglichkeit, Code zu durchsuchen und über Dienst-Hooks über Versionssteuerungsereignisse benachrichtigt zu werden.

Beispiele

Beispielanforderung

HTTP

POST https://almsearch.dev.azure.com/fabrikam/_apis/search/codesearchresults?api-version=7.1

{
  "searchText": "CodeSearchController",
  "$skip": 0,
  "$top": 1,
  "filters": {
    "Project": [
      "MyFirstProject"
    ],
    "Repository": [
      "MyFirstProject"
    ],
    "Path": [
      "/"
    ],
    "Branch": [
      "master"
    ],
    "CodeElement": [
      "def",
      "class"
    ]
  },
  "$orderBy": [
    {
      "field": "filename",
      "sortOrder": "ASC"
    }
  ],
  "includeFacets": true
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "count": 1,
  "results": [
    {
      "fileName": "CodeSearchController.cs",
      "path": "/CodeSearchController.cs",
      "matches": {
        "content": [
          {
            "charOffset": 1187,
            "length": 20
          },
          {
            "charOffset": 1395,
            "length": 20
          },
          {
            "charOffset": 1686,
            "length": 20
          }
        ],
        "fileName": [
          {
            "charOffset": 0,
            "length": -1
          }
        ]
      },
      "collection": {
        "name": "DefaultCollection"
      },
      "project": {
        "name": "MyFirstProject",
        "id": "00000000-0000-0000-0000-000000000000"
      },
      "repository": {
        "name": "MyFirstProject",
        "id": "c1548045-29f6-4354-8114-55ef058be1a3",
        "type": "git"
      },
      "versions": [
        {
          "branchName": "master",
          "changeId": "47e1cc8877baea4b7bb33af803d6cc697914f88b"
        }
      ],
      "contentId": "004898f1ad91c9c2a0f492f2d1174468bc3c84ef"
    }
  ],
  "infoCode": 0,
  "facets": {
    "Project": [
      {
        "name": "MyFirstProject",
        "id": "MyFirstProject",
        "resultCount": 1
      }
    ],
    "Repository": [
      {
        "name": "MyFirstProject",
        "id": "MyFirstProject",
        "resultCount": 1
      }
    ],
    "CodeElement": [
      {
        "name": "Class",
        "id": "class",
        "resultCount": 1
      },
      {
        "name": "Comment",
        "id": "comment",
        "resultCount": 1
      },
      {
        "name": "Definition",
        "id": "def",
        "resultCount": 1
      }
    ]
  }
}

Definitionen

Name	Beschreibung
CodeResult	Definiert das Codeergebnis, das Informationen der durchsuchten Dateien und deren Metadaten enthält.
CodeSearchRequest	Definiert eine Codesuchanforderung.
CodeSearchResponse	Definiert ein Codesuchantwortelement.
Collection	Definiert die Details der Auflistung.
Project	Definiert die Details des Projekts.
Repository	Definiert die Details des Repositorys.
SortOption	Definiert, wie das Ergebnis sortiert werden soll.
Version	Beschreibt die Details zu einer Version der Ergebnisdatei.
VersionControlType	Versionssteuerungstyp der Ergebnisdatei.

CodeResult

Objekt

Definiert das Codeergebnis, das Informationen der durchsuchten Dateien und deren Metadaten enthält.

Name	Typ	Beschreibung
collection	Collection	Sammlung der Ergebnisdatei.
contentId	string	ContentId der Ergebnisdatei.
fileName	string	Name der Ergebnisdatei.
matches	object	Wörterbuch des Felds, um offsets in der Ergebnisdatei zu treffen. Schlüssel identifiziert den Bereich, in dem Treffer gefunden wurden, z. B.: Dateiinhalt/Dateiname usw.
path	string	Pfad, unter dem die Ergebnisdatei vorhanden ist.
project	Project	Projekt der Ergebnisdatei.
repository	Repository	Repository der Ergebnisdatei.
versions	Version[]	Versionen der Ergebnisdatei.

CodeSearchRequest

Objekt

Definiert eine Codesuchanforderung.

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".
includeSnippet	boolean	Kennzeichnen, um sich für das Einschließen eines übereinstimmenden Codeausschnitts in das Ergebnis zu entscheiden. Das Standardverhalten ist "false".
searchText	string	Der Suchtext.

CodeSearchResponse

Objekt

Definiert ein Codesuchantwortelement.

Name	Typ	Beschreibung
count	integer (int32)	Gesamtanzahl der übereinstimmenen Dateien.
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	CodeResult[]	Liste der übereinstimmenen Dateien.

Collection

Objekt

Definiert die Details der Auflistung.

Name	Typ	Beschreibung
name	string	Name der Auflistung.

Project

Objekt

Definiert die Details des Projekts.

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

Repository

Objekt

Definiert die Details des Repositorys.

Name	Typ	Beschreibung
id	string	ID des Repositorys.
name	string	Name des Repositorys.
type	VersionControlType	Versionssteuerungstyp der Ergebnisdatei.

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.

Version

Objekt

Beschreibt die Details zu einer Version der Ergebnisdatei.

Name	Typ	Beschreibung
branchName	string	Name der Verzweigung.
changeId	string	ChangeId in der angegebenen Verzweigung, die dieser Übereinstimmung zugeordnet ist.

VersionControlType

Enumeration

Versionssteuerungstyp der Ergebnisdatei.

Wert	Beschreibung
custom	Für die interne Verwendung.
git
tfvc

Freigeben über

Code Search Results - Fetch Code Search Results

URI-Parameter

Anforderungstext

Antworten

Sicherheit

oauth2

Bereiche

Beispiele

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CodeResult

CodeSearchRequest

CodeSearchResponse

Collection

Project

Repository

SortOption

Version

VersionControlType

Zusätzliche Ressourcen