Code Search Results - Fetch Code Search Results

Référence

Service:: Search

Version d'API:: 7.1

Fournit un ensemble de résultats pour le texte de recherche.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
organization	path	True	string	Nom de l’organisation Azure DevOps.
project	path		string	ID de projet ou nom du projet
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1 » pour utiliser cette version de l’API.

Corps de la demande

Nom	Type	Description
$orderBy	SortOption[]	Options de tri des résultats de recherche. Si la valeur est null, les résultats sont retournés triés par pertinence. Si plusieurs options de tri sont fournies, les résultats sont triés dans l’ordre spécifié dans OrderBy.
$skip	integer (int32)	Nombre de résultats à ignorer.
$top	integer (int32)	Nombre de résultats à renvoyer.
filters	object	Filtres à appliquer. Définissez-le sur Null s’il n’existe aucun filtre à appliquer.
includeFacets	boolean	Indicateur permettant d’opter pour la facette dans le résultat. Le comportement par défaut est false.
includeSnippet	boolean	Indicateur permettant d’opter pour l’inclusion de l’extrait de code correspondant dans le résultat. Le comportement par défaut est false.
searchText	string	Texte de recherche.

Réponses

Nom	Type	Description
200 OK	CodeSearchResponse	opération réussie

Sécurité

oauth2

Type: oauth2
Flux: accessCode
URL d’autorisation: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL du jeton: 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

Étendues

Nom	Description
vso.code	Accorde la possibilité de lire le code source et les métadonnées sur les validations, les ensembles de modifications, les branches et d’autres artefacts de contrôle de version. Accorde également la possibilité de rechercher du code et d’être averti des événements de contrôle de version via des hooks de service.

Exemples

Exemple de requête

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
}

Exemple de réponse

Code d’état:: 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
      }
    ]
  }
}

Définitions

Nom	Description
CodeResult	Définit le résultat du code contenant des informations sur les fichiers recherchés et ses métadonnées.
CodeSearchRequest	Définit une demande de recherche de code.
CodeSearchResponse	Définit un élément de réponse de recherche de code.
Collection	Définit les détails de la collection.
Project	Définit les détails du projet.
Repository	Définit les détails du référentiel.
SortOption	Définit comment trier le résultat.
Version	Décrit les détails relatifs à une version du fichier de résultats.
VersionControlType	Type de contrôle de version du fichier de résultats.

CodeResult

Object

Définit le résultat du code contenant des informations sur les fichiers recherchés et ses métadonnées.

Nom	Type	Description
collection	Collection	Collection du fichier de résultats.
contentId	string	ContentId du fichier de résultats.
fileName	string	Nom du fichier de résultats.
matches	object	Dictionnaire de champs pour atteindre les décalages dans le fichier de résultats. La clé identifie la zone dans laquelle des accès ont été trouvés, par exemple : contenu de fichier/nom de fichier, etc.
path	string	Chemin d’accès au fichier de résultats présent.
project	Project	Projet du fichier de résultats.
repository	Repository	Référentiel du fichier de résultats.
versions	Version[]	Versions du fichier de résultats.

CodeSearchRequest

Object

Définit une demande de recherche de code.

Nom	Type	Description
$orderBy	SortOption[]	Options de tri des résultats de recherche. Si la valeur est null, les résultats sont retournés triés par pertinence. Si plusieurs options de tri sont fournies, les résultats sont triés dans l’ordre spécifié dans OrderBy.
$skip	integer (int32)	Nombre de résultats à ignorer.
$top	integer (int32)	Nombre de résultats à renvoyer.
filters	object	Filtres à appliquer. Définissez-le sur Null s’il n’existe aucun filtre à appliquer.
includeFacets	boolean	Indicateur permettant d’opter pour la facette dans le résultat. Le comportement par défaut est false.
includeSnippet	boolean	Indicateur permettant d’opter pour l’inclusion de l’extrait de code correspondant dans le résultat. Le comportement par défaut est false.
searchText	string	Texte de recherche.

CodeSearchResponse

Object

Définit un élément de réponse de recherche de code.

Nom	Type	Description
count	integer (int32)	Nombre total de fichiers correspondants.
facets	object	Dictionnaire stockant un tableau d’objets `Filter` par rapport à chaque facette.
infoCode	integer (int32)	Code numérique indiquant toutes les informations supplémentaires : 0 - Ok, 1 - Le compte est réindexé, 2 - L’indexation de compte n’a pas démarré, 3 - Requête non valide, 4 - Requête générique de préfixe non prise en charge, 5 - MultiWords avec facette de code non prise en charge, 6 - Compte en cours d’intégration, 7 - Compte en cours d’intégration ou réindexé, 8 - Première valeur rognée en maxresult autorisé 9 - Les branches sont indexées, 10 - Facette non activée, 11 - Éléments de travail non accessibles, 19 - Requêtes d’expressions avec filtres de type de code non pris en charge, 20 - Requêtes génériques avec filtres de type de code non pris en charge. Tout autre code d’informations est utilisé à des fins internes.
results	CodeResult[]	Liste des fichiers mis en correspondance.

Collection

Object

Définit les détails de la collection.

Nom	Type	Description
name	string	Nom de la collection.

Project

Object

Définit les détails du projet.

Nom	Type	Description
id	string (uuid)	ID du projet.
name	string	Nom du projet.

Repository

Object

Définit les détails du référentiel.

Nom	Type	Description
id	string	ID du référentiel.
name	string	Nom du référentiel.
type	VersionControlType	Type de contrôle de version du fichier de résultats.

SortOption

Object

Définit comment trier le résultat.

Nom	Type	Description
field	string	Nom du champ sur lequel le tri doit être effectué.
sortOrder	string	Ordre (ASC/DESC) dans lequel les résultats doivent être triés.

Version

Object

Décrit les détails relatifs à une version du fichier de résultats.

Nom	Type	Description
branchName	string	Nom de la branche.
changeId	string	ChangeId dans la branche donnée associée à cette correspondance.

VersionControlType

Énumération

Type de contrôle de version du fichier de résultats.

Valeur	Description
custom	Pour une utilisation interne.
git
tfvc

Partager via

Code Search Results - Fetch Code Search Results

Paramètres URI

Corps de la demande

Réponses

Sécurité

oauth2

Étendues

Exemples

Exemple de requête

Exemple de réponse

Définitions

CodeResult

CodeSearchRequest

CodeSearchResponse

Collection

Project

Repository

SortOption

Version

VersionControlType