Package Search Results - Fetch Package Search Results

Referencia

Service:: Search

API Version:: 7.1-preview.1

Proporciona un conjunto de resultados para el texto de búsqueda.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
organization	path	True	string	El nombre de la organización de Azure DevOps.
api-version	query	True	string	Versión de la API que se va a usar. Debe establecerse en "7.1-preview.1" para usar esta versión de la API.

Cuerpo de la solicitud

Nombre	Tipo	Description
$orderBy	SortOption[]	Opciones para ordenar los resultados de búsqueda. Si se establece en null, los resultados se devolverán ordenados por relevancia. Si se proporciona más de una opción de ordenación, los resultados se ordenan en el orden especificado en OrderBy.
$skip	integer	Número de resultados que se van a omitir.
$top	integer	Número de resultados que se van a devolver.
filters	object	Filtros que se van a aplicar. Establézcalo en NULL si no hay filtros que se van a aplicar.
includeFacets	boolean	Marca para optar por facetas en el resultado. El comportamiento predeterminado es false.
searchText	string	Texto de búsqueda.

Respuestas

Nombre	Tipo	Description
200 OK	PackageSearchResponseContent	operación correcta Headers ActivityId: string

Nombre

Tipo

Description

200 OK

PackageSearchResponseContent

operación correcta

Headers

ActivityId: string

Seguridad

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

Nombre	Description
vso.packaging	Concede la capacidad de leer fuentes y paquetes. También concede la capacidad de buscar paquetes.

Ejemplos

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

Definiciones

Nombre	Description
FeedInfo	Define los detalles de una fuente.
PackageHit	Define los términos coincidentes en el campo del resultado del paquete.
PackageResult	Define el resultado del paquete que coincide con una solicitud de búsqueda de paquetes.
PackageSearchRequest	Define una solicitud de búsqueda de paquetes.
PackageSearchResponseContent	Define un elemento de respuesta que se devuelve para una solicitud de búsqueda de paquetes.
SortOption	Define cómo ordenar el resultado.

FeedInfo

Define los detalles de una fuente.

Nombre	Tipo	Description
collectionId	string	Identificador de la colección.
collectionName	string	Nombre de la colección.
feedId	string	Id. de la fuente.
feedName	string	Nombre de la fuente.
latestMatchedVersion	string	Última versión coincidente del paquete en esta fuente.
latestVersion	string	Versión más reciente del paquete en esta fuente.
packageUrl	string	Dirección URL del paquete en esta fuente.
views	string[]	Lista de vistas que contienen el paquete coincidente.

PackageHit

Define los términos coincidentes en el campo del resultado del paquete.

Nombre	Tipo	Description
fieldReferenceName	string	Nombre de referencia del campo resaltado.
highlights	string[]	Fragmentos de código coincidentes o resaltados del campo.

PackageResult

Define el resultado del paquete que coincide con una solicitud de búsqueda de paquetes.

Nombre	Tipo	Description
description	string	Descripción del paquete.
feeds	FeedInfo[]	Lista de fuentes que contienen el paquete coincidente.
hits	PackageHit[]	Lista de campos resaltados para la coincidencia.
id	string	Identificador del paquete.
name	string	Nombre del paquete.
protocolType	string	Tipo del paquete.

PackageSearchRequest

Define una solicitud de búsqueda de paquetes.

Nombre	Tipo	Description
$orderBy	SortOption[]	Opciones para ordenar los resultados de búsqueda. Si se establece en null, los resultados se devolverán ordenados por relevancia. Si se proporciona más de una opción de ordenación, los resultados se ordenan en el orden especificado en OrderBy.
$skip	integer	Número de resultados que se van a omitir.
$top	integer	Número de resultados que se van a devolver.
filters	object	Filtros que se van a aplicar. Establézcalo en NULL si no hay filtros que se van a aplicar.
includeFacets	boolean	Marca para optar por facetas en el resultado. El comportamiento predeterminado es false.
searchText	string	Texto de búsqueda.

PackageSearchResponseContent

Define un elemento de respuesta que se devuelve para una solicitud de búsqueda de paquetes.

Nombre	Tipo	Description
count	integer	Número total de paquetes coincidentes.
facets	object	Diccionario que almacena una matriz de `Filter` objetos en cada faceta.
infoCode	integer	Código numérico que indica cualquier información adicional: 0 - Ok, 1 - Account is being reindexed, 2 - Account indexing has not started, 3 - Invalid Request, 4 - Prefix wildcard query not supported, 5 - MultiWords with code facet not supported, 6 - Account is being onboarded, 7 - Account is being onboarded or reindexed, 8 - Top value trimed to maxresult allowed 9 - Branches are being indexed, 10 - Facetas no habilitadas, 11 - Elementos de trabajo no accesibles, 19 - Consultas de frases con filtros de tipo de código no compatibles, 20 - Consultas con caracteres comodín con filtros de tipo de código no admitidos. Cualquier otro código de información se usa para fines internos.
results	PackageResult[]	Lista de paquetes coincidentes.

SortOption

Define cómo ordenar el resultado.

Nombre	Tipo	Description
field	string	Nombre de campo en el que se debe realizar la ordenación.
sortOrder	string	Orden (ASC/DESC) en el que se deben ordenar los resultados.

Package Search Results - Fetch Package Search Results

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

oauth2

Scopes

Ejemplos

Sample Request

Sample Response

Definiciones

FeedInfo

PackageHit

PackageResult

PackageSearchRequest

PackageSearchResponseContent

SortOption

Comentarios

Recursos adicionales