Package Search Results - Fetch Package Search Results

Arama metni için bir sonuç kümesi sağlar.

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

URI Parametreleri

Veri Akışı Adı İçinde Gerekli Tür Description
organization
path True

string

Azure DevOps kuruluşunun adı.

api-version
query True

string

Kullanılacak API'nin sürümü. Bu, API'nin bu sürümünü kullanmak için '7.1' olarak ayarlanmalıdır.

İstek Gövdesi

Veri Akışı Adı Tür Description
$orderBy

SortOption[]

Arama sonuçlarını sıralama seçenekleri. Null olarak ayarlanırsa, sonuçlar ilgi düzeyine göre sıralanmış olarak döndürülür. Birden fazla sıralama seçeneği sağlanırsa, sonuçlar OrderBy'de belirtilen düzende sıralanır.

$skip

integer (int32)

Atlanacak sonuç sayısı.

$top

integer (int32)

Döndürülecek sonuç sayısı.

filters

object

Uygulanacak filtreler. Uygulanacak filtre yoksa null olarak ayarlayın.

includeFacets

boolean

Sonuçta yüz tanımayı tercih etmek için bayrak. Varsayılan davranış false'tur.

searchText

string

Arama metni.

Yanıtlar

Veri Akışı Adı Tür Description
200 OK

PackageSearchResponseContent

başarılı işlem

Üst Bilgiler

ActivityId: string

Güvenlik

oauth2

Tür: oauth2
Akış: accessCode
Yetkilendirme URL’si: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Belirteç URL'si: 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

Kapsamlar

Veri Akışı Adı Description
vso.packaging Akışları ve paketleri okuma olanağı sağlar. Ayrıca paketleri arama olanağı da verir.

Örnekler

Örnek isteği

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

Örnek yanıt

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

Tanımlar

Veri Akışı Adı Description
FeedInfo

Akışın ayrıntılarını tanımlar.

PackageHit

Paket sonucunun alanındaki eşleşen terimleri tanımlar.

PackageResult

Paket arama isteğiyle eşleşen paket sonucunu tanımlar.

PackageSearchRequest

Bir paket arama isteği tanımlar.

PackageSearchResponseContent

Paket arama isteği için döndürülen bir yanıt öğesini tanımlar.

SortOption

Sonucun nasıl sıralanacağını tanımlar.

FeedInfo

Akışın ayrıntılarını tanımlar.

Veri Akışı Adı Tür Description
collectionId

string

Koleksiyonun kimliği.

collectionName

string

Koleksiyonun adı.

feedId

string

Akışın kimliği.

feedName

string

Akışın adı.

latestMatchedVersion

string

Bu Akıştaki paketin en son eşleşen sürümü.

latestVersion

string

Bu Akıştaki paketin en son sürümü.

packageUrl

string

Bu Akıştaki paketin URL'si.

views

string[]

Eşleşen paketi içeren görünümlerin listesi.

PackageHit

Paket sonucunun alanındaki eşleşen terimleri tanımlar.

Veri Akışı Adı Tür Description
fieldReferenceName

string

Vurgulanan alanın başvuru adı.

highlights

string[]

Alanın eşleştirilen/vurgulanan kod parçacıkları.

PackageResult

Paket arama isteğiyle eşleşen paket sonucunu tanımlar.

Veri Akışı Adı Tür Description
description

string

Paketin açıklaması.

feeds

FeedInfo[]

Eşleşen paketi içeren akışların listesi.

hits

PackageHit[]

Eşleşme için vurgulanan alanların listesi.

id

string

Paketin kimliği.

name

string

Paketin adı.

protocolType

string

Paketin türü.

PackageSearchRequest

Bir paket arama isteği tanımlar.

Veri Akışı Adı Tür Description
$orderBy

SortOption[]

Arama sonuçlarını sıralama seçenekleri. Null olarak ayarlanırsa, sonuçlar ilgi düzeyine göre sıralanmış olarak döndürülür. Birden fazla sıralama seçeneği sağlanırsa, sonuçlar OrderBy'de belirtilen düzende sıralanır.

$skip

integer (int32)

Atlanacak sonuç sayısı.

$top

integer (int32)

Döndürülecek sonuç sayısı.

filters

object

Uygulanacak filtreler. Uygulanacak filtre yoksa null olarak ayarlayın.

includeFacets

boolean

Sonuçta yüz tanımayı tercih etmek için bayrak. Varsayılan davranış false'tur.

searchText

string

Arama metni.

PackageSearchResponseContent

Paket arama isteği için döndürülen bir yanıt öğesini tanımlar.

Veri Akışı Adı Tür Description
count

integer (int32)

Eşleşen paketlerin toplam sayısı.

facets

object

Her modelde bir dizi Filter nesnesi depolar.

infoCode

integer (int32)

Ek bilgileri gösteren sayısal kod: 0 - Tamam, 1 - Hesap yeniden dizinleniyor, 2 - Hesap dizin oluşturma başlatılmadı, 3 - Geçersiz İstek, 4 - Ön ek joker karakter sorgusu desteklenmiyor, 5 - Kod modelli MultiWords desteklenmiyor, 6 - Hesap ekleniyor, 7 - Hesap ekleniyor veya yeniden dizinleniyor, 8 - En yüksek değer maxresult izin verilen 9'a kırpılıyor - Dallar dizinleniyor, 10 - Model oluşturma etkin değil, 11 - İş öğeleri erişilebilir değil, 19 - Kod türü filtreleri desteklenmeyen tümcecik sorguları, 20 - Kod türü filtreleri desteklenmeyen joker karakter sorguları. Diğer tüm bilgi kodları iç amaçla kullanılır.

results

PackageResult[]

Eşleşen paketlerin listesi.

SortOption

Sonucun nasıl sıralanacağını tanımlar.

Veri Akışı Adı Tür Description
field

string

Sıralamanın yapılması gereken alan adı.

sortOrder

string

Sonuçların sıralanması gereken düzen (ASC/DESC).