Package Search Results - Fetch Package 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}/_apis/search/packagesearchresults?api-version=7.1-preview.1

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
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 dieser Wert auf NULL festgelegt ist, 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ückzugebenden Ergebnisse.
filters	object	Anzuwendende Filter. Legen Sie ihn auf NULL fest, wenn keine Filter angewendet werden sollen.
includeFacets	boolean	Kennzeichnen, um sich für die Facettierung im Ergebnis zu entscheiden. Das Standardverhalten ist false.
searchText	string	Der Suchtext.

Antworten

Name	Typ	Beschreibung
200 OK	PackageSearchResponseContent	Erfolgreicher Vorgang Headers ActivityId: string

Name

Typ

Beschreibung

200 OK

PackageSearchResponseContent

Erfolgreicher Vorgang

Headers

ActivityId: string

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.packaging	Gewährt die Möglichkeit, Feeds und Pakete zu lesen. Gewährt auch die Möglichkeit, Pakete zu durchsuchen.

Beispiele

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

Definitionen

Name	Beschreibung
FeedInfo	Definiert die Details eines Feeds.
PackageHit	Definiert die übereinstimmend bezeichneten Begriffe im Feld des Paketergebnisses.
PackageResult	Definiert das Paketergebnis, das einer Paketsuchanforderung entspricht.
PackageSearchRequest	Definiert eine Paketsuchanforderung.
PackageSearchResponseContent	Definiert ein Antwortelement, das für eine Paketsuchanforderung zurückgegeben wird.
SortOption	Definiert, wie das Ergebnis sortiert wird.

FeedInfo

Definiert die Details eines Feeds.

Name	Typ	Beschreibung
collectionId	string	ID der Auflistung.
collectionName	string	Name der Sammlung
feedId	string	ID des Feeds.
feedName	string	Name des Feeds.
latestMatchedVersion	string	Die neueste übereinstimmene Version des Pakets in diesem Feed.
latestVersion	string	Neueste Version des Pakets in diesem Feed.
packageUrl	string	Url des Pakets in diesem Feed.
views	string[]	Liste der Ansichten, die das übereinstimmene Paket enthalten.

PackageHit

Definiert die übereinstimmend bezeichneten Begriffe im Feld des Paketergebnisses.

Name	Typ	Beschreibung
fieldReferenceName	string	Verweisname des hervorgehobenen Felds.
highlights	string[]	Übereinstimmend/hervorgehobene Codeausschnitte des Felds.

PackageResult

Definiert das Paketergebnis, das einer Paketsuchanforderung entspricht.

Name	Typ	Beschreibung
description	string	Beschreibung des Pakets.
feeds	FeedInfo[]	Liste der Feeds, die das übereinstimmende Paket enthalten.
hits	PackageHit[]	Liste der hervorgehobenen Felder für die Übereinstimmung.
id	string	ID des Pakets.
name	string	Name des Pakets.
protocolType	string	Typ des Pakets.

PackageSearchRequest

Definiert eine Paketsuchanforderung.

Name	Typ	Beschreibung
$orderBy	SortOption[]	Optionen zum Sortieren von Suchergebnissen. Wenn dieser Wert auf NULL festgelegt ist, 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ückzugebenden Ergebnisse.
filters	object	Anzuwendende Filter. Legen Sie ihn auf NULL fest, wenn keine Filter angewendet werden sollen.
includeFacets	boolean	Kennzeichnen, um sich für die Facettierung im Ergebnis zu entscheiden. Das Standardverhalten ist false.
searchText	string	Der Suchtext.

PackageSearchResponseContent

Definiert ein Antwortelement, das für eine Paketsuchanforderung zurückgegeben wird.

Name	Typ	Beschreibung
count	integer	Gesamtanzahl der übereinstimmend zugeordneten Pakete.
facets	object	Ein Wörterbuch, das ein Array von `Filter` Objekten 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äfix-Wildcardabfrage 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 maxresult zulässig 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	PackageResult[]	Liste der übereinstimmend zugeordneten Pakete.

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.

Freigeben über

Package Search Results - Fetch Package Search Results

URI-Parameter

Anforderungstext

Antworten

Sicherheit

oauth2

Scopes

Beispiele

Sample Request

Sample Response

Definitionen

FeedInfo

PackageHit

PackageResult

PackageSearchRequest

PackageSearchResponseContent

SortOption

Zusätzliche Ressourcen