Partager via


Package Search Results - Fetch Package Search Results

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

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

Paramètres URI

Nom Dans Obligatoire Type Description
organization
path True

string

Nom de l’organisation Azure DevOps.

api-version
query True

string

Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1-preview.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

Nombre de résultats à ignorer.

$top

integer

Nombre de résultats à retourner.

filters

object

Filtres à appliquer. Définissez-le sur null s’il n’y a aucun filtre à appliquer.

includeFacets

boolean

Indicateur d’opter pour la facette dans le résultat. Le comportement par défaut est false.

searchText

string

Texte de la recherche.

Réponses

Nom Type Description
200 OK

PackageSearchResponseContent

opération réussie

Headers

ActivityId: string

Sécurité

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

Nom Description
vso.packaging Octroie la possibilité de lire des flux et des packages. Accorde également la possibilité de rechercher des packages.

Exemples

Sample Request

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

{
  "$skip": 0,
  "$top": 50,
  "$orderBy": null,
  "includeFacets": true,
  "searchText": "microsoft applicationinsight package",
  "filters": {
    "Feeds": [
      "ApplicationInsights-Team"
    ],
    "View": [
      "local"
    ],
    "ProtocolType": [
      "Nuget",
      "Npm"
    ]
  }
}

Sample Response

{
  "count": 3,
  "results": [
    {
      "name": "@microsoft/applicationinsights-mezzurite",
      "id": "0adc5b40-8b48-4a42-ac5e-93da78206d27",
      "description": "Logging Extention for Mezzurtie Timing Package",
      "protocolType": "Npm",
      "feeds": [
        {
          "collectionId": "0efb4611-d565-4cd1-9a64-7d6cb6d7d5f0",
          "collectionName": "mseng",
          "feedId": "cd3f7228-b239-4ef5-8d3b-ee9c3bc79bc2",
          "feedName": "ApplicationInsights-Team",
          "packageUrl": "https://dev.azure.com/mseng/_packaging?feed=ApplicationInsights-Team&_a=package&package=@microsoft/applicationinsights-mezzurite&version=1.0.0&protocolType=Npm",
          "latestVersion": "1.0.0",
          "latestMatchedVersion": "1.0.0",
          "views": [
            "local"
          ]
        }
      ],
      "hits": [
        {
          "fieldReferenceName": "name",
          "highlights": [
            "@<highlighthit>microsoft</highlighthit>/<highlighthit>applicationinsights</highlighthit>-mezzurite"
          ]
        },
        {
          "fieldReferenceName": "description",
          "highlights": [
            "Logging Extention for Mezzurtie Timing <highlighthit>Package</highlighthit>"
          ]
        }
      ]
    },
    {
      "name": "Microsoft.ApplicationInsights.Masi.Tracing",
      "id": "5b709505-a14f-4d2c-b172-21f1e6fc0562",
      "description": "The MASI tracing package allowing you to send log messages with activity context to Application Insights and to Windows Azure Diagnostics easily",
      "protocolType": "NuGet",
      "feeds": [
        {
          "collectionId": "0efb4611-d565-4cd1-9a64-7d6cb6d7d5f0",
          "collectionName": "mseng",
          "feedId": "cd3f7228-b239-4ef5-8d3b-ee9c3bc79bc2",
          "feedName": "ApplicationInsights-Team",
          "packageUrl": "https://dev.azure.com/mseng/_packaging?feed=ApplicationInsights-Team&_a=package&package=Microsoft.ApplicationInsights.Masi.Tracing&version=1.0.13.2-build00132-2&protocolType=NuGet",
          "latestVersion": "1.0.13.2-build00132-2",
          "latestMatchedVersion": "1.0.13.2-build00132-2",
          "views": [
            "local"
          ]
        }
      ],
      "hits": [
        {
          "fieldReferenceName": "name",
          "highlights": [
            "<highlighthit>Microsoft</highlighthit>.<highlighthit>ApplicationInsights</highlighthit>.Masi.Tracing"
          ]
        },
        {
          "fieldReferenceName": "description",
          "highlights": [
            "The MASI tracing <highlighthit>package</highlighthit> allowing you to send log messages with activity context to Application"
          ]
        }
      ]
    },
    {
      "name": "Microsoft.ApplicationInsights.Agent.StartupTask",
      "id": "60c357c1-69bf-4c9b-8fe0-a8ad7e50a5f9",
      "description": "Application Insights Agent startup task. This package adds a startup task for installing Application Insights Agent to enable additional Application Insights Telemetry.",
      "protocolType": "NuGet",
      "feeds": [
        {
          "collectionId": "0efb4611-d565-4cd1-9a64-7d6cb6d7d5f0",
          "collectionName": "mseng",
          "feedId": "cd3f7228-b239-4ef5-8d3b-ee9c3bc79bc2",
          "feedName": "ApplicationInsights-Team",
          "packageUrl": "https://dev.azure.com/mseng/_packaging?feed=ApplicationInsights-Team&_a=package&package=Microsoft.ApplicationInsights.Agent.StartupTask&version=1.0.5&protocolType=NuGet",
          "latestVersion": "1.0.5",
          "latestMatchedVersion": "1.0.5",
          "views": [
            "local"
          ]
        }
      ],
      "hits": [
        {
          "fieldReferenceName": "name",
          "highlights": [
            "<highlighthit>Microsoft</highlighthit>.<highlighthit>ApplicationInsights</highlighthit>.Agent.StartupTask"
          ]
        },
        {
          "fieldReferenceName": "description",
          "highlights": [
            "This <highlighthit>package</highlighthit> adds a startup task for installing Application Insights Agent to enable additional"
          ]
        }
      ]
    }
  ],
  "infoCode": 0,
  "facets": {
    "ProtocolType": [
      {
        "name": "Npm",
        "id": "Npm",
        "resultCount": 1
      },
      {
        "name": "NuGet",
        "id": "NuGet",
        "resultCount": 2
      }
    ],
    "Feeds": [
      {
        "name": "ApexPreRelease",
        "id": "ApexPreRelease",
        "resultCount": 4
      },
      {
        "name": "ApplicationInsights-dotnet-develop",
        "id": "ApplicationInsights-dotnet-develop",
        "resultCount": 3
      },
      {
        "name": "ApplicationInsights-Team",
        "id": "ApplicationInsights-Team",
        "resultCount": 3
      },
      {
        "name": "ArtifactTool",
        "id": "ArtifactTool",
        "resultCount": 1
      },
      {
        "name": "Axon.Dependencies",
        "id": "Axon.Dependencies",
        "resultCount": 4
      },
      {
        "name": "CloudBuild",
        "id": "CloudBuild",
        "resultCount": 1
      },
      {
        "name": "CloudBuildTest",
        "id": "CloudBuildTest",
        "resultCount": 1
      },
      {
        "name": "CodeFlow",
        "id": "CodeFlow",
        "resultCount": 3
      },
      {
        "name": "Codex-Deps",
        "id": "Codex-Deps",
        "resultCount": 4
      },
      {
        "name": "Kusto-Internal",
        "id": "Kusto-Internal",
        "resultCount": 4
      },
      {
        "name": "MSCredProvider",
        "id": "MSCredProvider",
        "resultCount": 2
      },
      {
        "name": "VS",
        "id": "VS",
        "resultCount": 7
      },
      {
        "name": "VsoMicrosoftExternals",
        "id": "VsoMicrosoftExternals",
        "resultCount": 3
      }
    ],
    "View": [
      {
        "name": "Local",
        "id": "Local",
        "resultCount": 3
      }
    ]
  }
}

Définitions

Nom Description
FeedInfo

Définit les détails d’un flux.

PackageHit

Définit les termes mis en correspondance dans le champ du résultat du package.

PackageResult

Définit le résultat du package correspondant à une demande de recherche de package.

PackageSearchRequest

Définit une demande de recherche de package.

PackageSearchResponseContent

Définit un élément de réponse retourné pour une demande de recherche de package.

SortOption

Définit comment trier le résultat.

FeedInfo

Définit les détails d’un flux.

Nom Type Description
collectionId

string

ID de la collection.

collectionName

string

Nom de la collection.

feedId

string

ID du flux.

feedName

string

Nom du flux.

latestMatchedVersion

string

Dernière version correspondante du package dans ce flux.

latestVersion

string

Dernière version du package dans ce flux.

packageUrl

string

URL du package dans ce flux.

views

string[]

Liste des vues qui contiennent le package correspondant.

PackageHit

Définit les termes mis en correspondance dans le champ du résultat du package.

Nom Type Description
fieldReferenceName

string

Nom de référence du champ en surbrillance.

highlights

string[]

Extraits de code mis en correspondance/mis en évidence du champ.

PackageResult

Définit le résultat du package correspondant à une demande de recherche de package.

Nom Type Description
description

string

Description du package.

feeds

FeedInfo[]

Liste des flux qui contiennent le package correspondant.

hits

PackageHit[]

Liste des champs mis en surbrillance pour la correspondance.

id

string

ID du package.

name

string

Nom du package.

protocolType

string

Type du package.

PackageSearchRequest

Définit une demande de recherche de package.

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

Nombre de résultats à ignorer.

$top

integer

Nombre de résultats à retourner.

filters

object

Filtres à appliquer. Définissez-le sur null s’il n’y a aucun filtre à appliquer.

includeFacets

boolean

Indicateur d’opter pour la facette dans le résultat. Le comportement par défaut est false.

searchText

string

Texte de la recherche.

PackageSearchResponseContent

Définit un élément de réponse retourné pour une demande de recherche de package.

Nom Type Description
count

integer

Nombre total de packages correspondants.

facets

object

Dictionnaire stockant un tableau d’objet Filter sur chaque facette.

infoCode

integer

Code numérique indiquant des informations supplémentaires : 0 - Ok, 1 - Le compte est en cours de réindexation, 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 de réindexation, 8 - Valeur supérieure réduite à maxresult autorisé 9 - Les branches sont en cours d’indexation, 10 - Facettes non activées, 11 - Éléments de travail non accessibles, 19 - Requêtes d’expressions avec des filtres de type de code non pris en charge, 20 - Requêtes génériques avec des filtres de type de code non pris en charge. Tout autre code d’informations est utilisé à des fins internes.

results

PackageResult[]

Liste des packages correspondants.

SortOption

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.