Package Search Results - Fetch Package Search Results

Odwołanie

Usługa:: Search

Wersja interfejsu API:: 7.1

Zawiera zestaw wyników dla tekstu wyszukiwania.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
api-version	query	True	string	Wersja interfejsu API do użycia. Należy ustawić wartość "7.1", aby używać tej wersji interfejsu API.

Treść żądania

Nazwa	Typ	Opis
$orderBy	SortOption[]	Opcje sortowania wyników wyszukiwania. Jeśli zostanie ustawiona wartość null, wyniki zostaną zwrócone posortowane według istotności. Jeśli podano więcej niż jedną opcję sortowania, wyniki są sortowane w kolejności określonej w kolumnie OrderBy.
$skip	integer (int32)	Liczba wyników do pominięcia.
$top	integer (int32)	Liczba wyników do zwrócenia.
filters	object	Filtry do zastosowania. Ustaw wartość null, jeśli nie ma żadnych filtrów do zastosowania.
includeFacets	boolean	Flaga, aby wybrać aspektowanie w wyniku. Domyślne zachowanie to fałsz.
searchText	string	Tekst wyszukiwania.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PackageSearchResponseContent	operacja zakończona powodzeniem Nagłówki ActivityId: string

Nazwa

Typ

Opis

200 OK

PackageSearchResponseContent

operacja zakończona powodzeniem

Nagłówki

ActivityId: string

Zabezpieczenia

oauth2

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Adres URL tokenu: 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

Zakresy

Nazwa	Opis
vso.packaging	Przyznaje możliwość odczytywania kanałów informacyjnych i pakietów. Ponadto umożliwia wyszukiwanie pakietów.

Przykłady

Przykładowe żądanie

HTTP

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

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

Przykładowa odpowiedź

Kod stanu:: 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
      }
    ]
  }
}

Definicje

Nazwa	Opis
FeedInfo	Definiuje szczegóły źródła danych.
PackageHit	Definiuje dopasowane terminy w polu wyniku pakietu.
PackageResult	Definiuje wynik pakietu pasujący do żądania wyszukiwania pakietu.
PackageSearchRequest	Definiuje żądanie wyszukiwania pakietów.
PackageSearchResponseContent	Definiuje element odpowiedzi zwracany dla żądania wyszukiwania pakietu.
SortOption	Definiuje sposób sortowania wyniku.

FeedInfo

Objekt

Definiuje szczegóły źródła danych.

Nazwa	Typ	Opis
collectionId	string	Identyfikator kolekcji.
collectionName	string	Nazwa kolekcji.
feedId	string	Identyfikator kanału informacyjnego.
feedName	string	Nazwa kanału informacyjnego.
latestMatchedVersion	string	Najnowsza zgodna wersja pakietu w tym kanale informacyjnym.
latestVersion	string	Najnowsza wersja pakietu w tym kanale informacyjnym.
packageUrl	string	Adres URL pakietu w tym kanale informacyjnym.
views	string[]	Lista widoków zawierających dopasowany pakiet.

PackageHit

Objekt

Definiuje dopasowane terminy w polu wyniku pakietu.

Nazwa	Typ	Opis
fieldReferenceName	string	Nazwa odwołania do wyróżnionego pola.
highlights	string[]	Dopasowane/wyróżnione fragmenty pola.

PackageResult

Objekt

Definiuje wynik pakietu pasujący do żądania wyszukiwania pakietu.

Nazwa	Typ	Opis
description	string	Opis pakietu.
feeds	FeedInfo[]	Lista kanałów informacyjnych zawierających pasujący pakiet.
hits	PackageHit[]	Lista wyróżnionych pól dla dopasowania.
id	string	Identyfikator pakietu.
name	string	Nazwa pakietu.
protocolType	string	Typ pakietu.

PackageSearchRequest

Objekt

Definiuje żądanie wyszukiwania pakietów.

Nazwa	Typ	Opis
$orderBy	SortOption[]	Opcje sortowania wyników wyszukiwania. Jeśli zostanie ustawiona wartość null, wyniki zostaną zwrócone posortowane według istotności. Jeśli podano więcej niż jedną opcję sortowania, wyniki są sortowane w kolejności określonej w kolumnie OrderBy.
$skip	integer (int32)	Liczba wyników do pominięcia.
$top	integer (int32)	Liczba wyników do zwrócenia.
filters	object	Filtry do zastosowania. Ustaw wartość null, jeśli nie ma żadnych filtrów do zastosowania.
includeFacets	boolean	Flaga, aby wybrać aspektowanie w wyniku. Domyślne zachowanie to fałsz.
searchText	string	Tekst wyszukiwania.

PackageSearchResponseContent

Objekt

Definiuje element odpowiedzi zwracany dla żądania wyszukiwania pakietu.

Nazwa	Typ	Opis
count	integer (int32)	Łączna liczba dopasowanych pakietów.
facets	object	Słownik przechowującą tablicę obiektów `Filter` względem każdego aspektu.
infoCode	integer (int32)	Kod liczbowy wskazujący dodatkowe informacje: 0 — Ok, 1 — Konto jest ponownie indeksowane, 2 — Indeksowanie konta nie zostało uruchomione, 3 — Nieprawidłowe żądanie, 4 — Kwerenda wieloznaczna prefiksu nie jest obsługiwana, 5 — MultiWords z nieobsługiwanym aspektem kodu, 6 — Konto jest dołączane, 7 — Konto jest dołączane lub ponownie indeksowane, 8 — maksymalna wartość przycinana do maksymalnego dozwolonego 9 — Gałęzie są indeksowane, 10 — Nie włączono tworzenia aspektów, 11 — elementy robocze nie są dostępne, 19 — zapytania fraz z filtrami typów kodu nieobsługiwane, 20 — zapytania wieloznaczne z filtrami typu kodu nieobsługiwane. Każdy inny kod informacyjny jest używany do celów wewnętrznych.
results	PackageResult[]	Lista pasowanych pakietów.

SortOption

Objekt

Definiuje sposób sortowania wyniku.

Nazwa	Typ	Opis
field	string	Nazwa pola, w którym należy przeprowadzić sortowanie.
sortOrder	string	Kolejność (ASC/DESC), w której wyniki powinny być sortowane.

Udostępnij za pośrednictwem

Package Search Results - Fetch Package Search Results

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

oauth2

Zakresy

Przykłady

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

FeedInfo

PackageHit

PackageResult

PackageSearchRequest

PackageSearchResponseContent

SortOption

Dodatkowe zasoby