Package Search Results - Fetch Package Search Results

Riferimento

Service:: Search

API Version:: 7.1-preview.1

Fornisce un set di risultati per il testo di ricerca.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
api-version	query	True	string	Versione dell'API da usare. Deve essere impostato su '7.1-preview.1' per usare questa versione dell'API.

Corpo della richiesta

Nome	Tipo	Descrizione
$orderBy	SortOption[]	Opzioni per l'ordinamento dei risultati della ricerca. Se impostato su Null, i risultati verranno restituiti ordinati in base alla pertinenza. Se vengono fornite più opzioni di ordinamento, i risultati vengono ordinati nell'ordine specificato in OrderBy.
$skip	integer	Numero di risultati da ignorare.
$top	integer	Numero di risultati da restituire.
filters	object	Filtri da applicare. Impostarlo su Null se non sono presenti filtri da applicare.
includeFacets	boolean	Flag per scegliere il faceting nel risultato. Il comportamento predefinito è false.
searchText	string	Testo di ricerca.

Risposte

Nome	Tipo	Descrizione
200 OK	PackageSearchResponseContent	operazione riuscita Headers ActivityId: string

Nome

Tipo

Descrizione

200 OK

PackageSearchResponseContent

operazione riuscita

Headers

ActivityId: string

Sicurezza

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

Nome	Descrizione
vso.packaging	Concede la possibilità di leggere feed e pacchetti. Concede inoltre la possibilità di eseguire ricerche nei pacchetti.

Esempio

Sample Request

HTTP

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

Status code:: 200

{
  "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
      }
    ]
  }
}

Definizioni

Nome	Descrizione
FeedInfo	Definisce i dettagli di un feed.
PackageHit	Definisce i termini corrispondenti nel campo del risultato del pacchetto.
PackageResult	Definisce il risultato del pacchetto corrispondente a una richiesta di ricerca del pacchetto.
PackageSearchRequest	Definisce una richiesta di ricerca del pacchetto.
PackageSearchResponseContent	Definisce un elemento di risposta restituito per una richiesta di ricerca del pacchetto.
SortOption	Definisce come ordinare il risultato.

FeedInfo

Definisce i dettagli di un feed.

Nome	Tipo	Descrizione
collectionId	string	ID della raccolta.
collectionName	string	Nome della raccolta.
feedId	string	ID del feed.
feedName	string	Nome del feed.
latestMatchedVersion	string	Ultima versione corrispondente del pacchetto in questo feed.
latestVersion	string	Versione più recente del pacchetto in questo feed.
packageUrl	string	URL del pacchetto in questo feed.
views	string[]	Elenco di visualizzazioni che contengono il pacchetto corrispondente.

PackageHit

Definisce i termini corrispondenti nel campo del risultato del pacchetto.

Nome	Tipo	Descrizione
fieldReferenceName	string	Nome di riferimento del campo evidenziato.
highlights	string[]	Frammenti corrispondenti/evidenziati del campo.

PackageResult

Definisce il risultato del pacchetto corrispondente a una richiesta di ricerca del pacchetto.

Nome	Tipo	Descrizione
description	string	Descrizione del pacchetto.
feeds	FeedInfo[]	Elenco di feed che contengono il pacchetto corrispondente.
hits	PackageHit[]	Elenco di campi evidenziati per la corrispondenza.
id	string	ID del pacchetto.
name	string	Nome del pacchetto.
protocolType	string	Tipo del pacchetto.

PackageSearchRequest

Definisce una richiesta di ricerca del pacchetto.

Nome	Tipo	Descrizione
$orderBy	SortOption[]	Opzioni per l'ordinamento dei risultati della ricerca. Se impostato su Null, i risultati verranno restituiti ordinati in base alla pertinenza. Se vengono fornite più opzioni di ordinamento, i risultati vengono ordinati nell'ordine specificato in OrderBy.
$skip	integer	Numero di risultati da ignorare.
$top	integer	Numero di risultati da restituire.
filters	object	Filtri da applicare. Impostarlo su Null se non sono presenti filtri da applicare.
includeFacets	boolean	Flag per scegliere il faceting nel risultato. Il comportamento predefinito è false.
searchText	string	Testo di ricerca.

PackageSearchResponseContent

Definisce un elemento di risposta restituito per una richiesta di ricerca del pacchetto.

Nome	Tipo	Descrizione
count	integer	Numero totale di pacchetti corrispondenti.
facets	object	Dizionario che archivia una matrice di `Filter` oggetti in base a ogni facet.
infoCode	integer	Codice numerico che indica eventuali informazioni aggiuntive: 0 - Ok, 1 - Account in fase di reindicizzazione, 2 - L'indicizzazione dell'account non è stata avviata, 3 - Richiesta non valida, 4 - Query con caratteri jolly con prefisso non supportato, 5 - MultiWords con facet di codice non supportato, 6 - L'account viene eseguito l'onboarding o la reindicizzazione dell'account, 8 - Valore superiore tagliato a maxresult consentito 9 - I rami vengono indicizzati, 10 - Facet non abilitato, 11 - Elementi di lavoro non accessibili, 19 - Query di frasi con filtri di tipo di codice non supportati, 20 - Query con caratteri jolly con filtri di tipo di codice non supportati. Qualsiasi altro codice informativo viene usato a scopo interno.
results	PackageResult[]	Elenco di pacchetti corrispondenti.

SortOption

Definisce come ordinare il risultato.

Nome	Tipo	Descrizione
field	string	Nome del campo in base al quale eseguire l'ordinamento.
sortOrder	string	Ordine (ASC/DESC) in cui devono essere ordinati i risultati.

Condividi tramite

Package Search Results - Fetch Package Search Results

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

oauth2

Scopes

Esempio

Sample Request

Sample Response

Definizioni

FeedInfo

PackageHit

PackageResult

PackageSearchRequest

PackageSearchResponseContent

SortOption

Risorse aggiuntive