Code Search Results - Fetch Code 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/codesearchresults?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.
includeSnippet	boolean	Kennzeichnen Sie, um sich für die Aufnahme 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

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.code	Ermöglicht das Lesen von Quellcode und Metadaten zu Commits, Changesets, Branches und anderen Versionskontrollartefakten. Ermöglicht außerdem die Suche nach Code und die Benachrichtigung über Versionskontrollereignisse über Diensthaken.

Beispiele

Sample Request

HTTP

POST https://almsearch.dev.azure.com/fabrikam/_apis/search/codesearchresults?api-version=7.1-preview.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
}

Sample Response

Status code:: 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 zu den durchsuchten Dateien und den zugehörigen Metadaten enthält.
CodeSearchRequest	Definiert eine Codesuchanforderung.
CodeSearchResponse	Definiert ein Antwortelement für die Codesuche.
Collection	Definiert die Details der Auflistung.
Project	Definiert die Details des Projekts.
Repository	Definiert die Details des Repositorys.
SortOption	Definiert, wie das Ergebnis sortiert wird.
Version	Beschreibt die Details zu einer Version der Ergebnisdatei.
VersionControlType	Versionskontrolltyp der Ergebnisdatei.

CodeResult

Definiert das Codeergebnis, das Informationen zu den durchsuchten Dateien und den zugehörigen 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. Key identifiziert den Bereich, in dem Treffer gefunden wurden, z. B. Dateiinhalt/Dateiname usw.
path	string	Pfad, an dem die Ergebnisdatei vorhanden ist.
project	Project	Projekt der Ergebnisdatei.
repository	Repository	Repository der Ergebnisdatei.
versions	Version[]	Versionen der Ergebnisdatei.

CodeSearchRequest

Definiert eine Codesuchanforderung.

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

CodeSearchResponse

Definiert ein Antwortelement für die Codesuche.

Name	Typ	Beschreibung
count	integer	Gesamtanzahl übereinstimmener Dateien.
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	CodeResult[]	Liste der zugeordneten Dateien.

Collection

Definiert die Details der Auflistung.

Name	Typ	Beschreibung
name	string	Name der Sammlung

Project

Definiert die Details des Projekts.

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

Repository

Definiert die Details des Repositorys.

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

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.

Version

Beschreibt die Details zu einer Version der Ergebnisdatei.

Name	Typ	Beschreibung
branchName	string	Name des Branchs.
changeId	string	ChangeId in dem angegebenen Branch, der dieser Übereinstimmung zugeordnet ist.

VersionControlType

Versionskontrolltyp der Ergebnisdatei.

Name	Typ	Beschreibung
custom	string	Für die interne Verwendung.
git	string
tfvc	string

Freigeben über