Package Search Results - Fetch Package Search Results

참조

Service:: Search

API Version:: 7.1-preview.1

검색 텍스트에 대한 결과 집합을 제공합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
organization	path	True	string	Azure DevOps 조직의 이름입니다.
api-version	query	True	string	사용할 API의 버전입니다. 이 버전의 api를 사용하려면 '7.1-preview.1'로 설정해야 합니다.

요청 본문

Name	형식	Description
$orderBy	SortOption[]	검색 결과를 정렬하는 옵션입니다. null로 설정하면 결과가 관련성별로 정렬된 상태로 반환됩니다. 둘 이상의 정렬 옵션이 제공되면 결과는 OrderBy에 지정된 순서대로 정렬됩니다.
$skip	integer	건너뛸 결과 수입니다.
$top	integer	반환할 결과 수입니다.
filters	object	적용할 필터입니다. 적용할 필터가 없는 경우 null로 설정합니다.
includeFacets	boolean	결과에서 패싯을 선택하는 플래그입니다. 기본 동작은 false입니다.
searchText	string	검색 텍스트입니다.

응답

Name	형식	Description
200 OK	PackageSearchResponseContent	성공한 작업 Headers ActivityId: string

Name

형식

Description

200 OK

PackageSearchResponseContent

성공한 작업

Headers

ActivityId: string

보안

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	Description
vso.packaging	피드 및 패키지를 읽을 수 있는 기능을 부여합니다. 또한 패키지를 검색할 수 있는 기능도 부여합니다.

예제

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

정의

Name	Description
FeedInfo	피드의 세부 정보를 정의합니다.
PackageHit	패키지 결과 필드에서 일치하는 용어를 정의합니다.
PackageResult	패키지 검색 요청과 일치하는 패키지 결과를 정의합니다.
PackageSearchRequest	패키지 검색 요청을 정의합니다.
PackageSearchResponseContent	패키지 검색 요청에 대해 반환되는 응답 항목을 정의합니다.
SortOption	결과를 정렬하는 방법을 정의합니다.

FeedInfo

피드의 세부 정보를 정의합니다.

Name	형식	Description
collectionId	string	컬렉션의 ID입니다.
collectionName	string	컬렉션의 이름입니다.
feedId	string	피드의 ID입니다.
feedName	string	피드의 이름입니다.
latestMatchedVersion	string	이 피드에서 일치하는 최신 버전의 패키지입니다.
latestVersion	string	이 피드의 최신 패키지 버전입니다.
packageUrl	string	이 피드에 있는 패키지의 URL입니다.
views	string[]	일치하는 패키지를 포함하는 뷰 목록입니다.

PackageHit

패키지 결과 필드에서 일치하는 용어를 정의합니다.

Name	형식	Description
fieldReferenceName	string	강조 표시된 필드의 참조 이름입니다.
highlights	string[]	필드의 일치/강조 표시된 코드 조각입니다.

PackageResult

패키지 검색 요청과 일치하는 패키지 결과를 정의합니다.

Name	형식	Description
description	string	패키지에 대한 설명입니다.
feeds	FeedInfo[]	일치하는 패키지를 포함하는 피드 목록입니다.
hits	PackageHit[]	일치 항목에 대해 강조 표시된 필드 목록입니다.
id	string	패키지의 ID입니다.
name	string	패키지의 이름입니다.
protocolType	string	패키지의 유형입니다.

PackageSearchRequest

패키지 검색 요청을 정의합니다.

Name	형식	Description
$orderBy	SortOption[]	검색 결과를 정렬하는 옵션입니다. null로 설정하면 결과가 관련성별로 정렬된 상태로 반환됩니다. 둘 이상의 정렬 옵션이 제공되면 결과는 OrderBy에 지정된 순서대로 정렬됩니다.
$skip	integer	건너뛸 결과 수입니다.
$top	integer	반환할 결과 수입니다.
filters	object	적용할 필터입니다. 적용할 필터가 없는 경우 null로 설정합니다.
includeFacets	boolean	결과에서 패싯을 선택하는 플래그입니다. 기본 동작은 false입니다.
searchText	string	검색 텍스트입니다.

PackageSearchResponseContent

패키지 검색 요청에 대해 반환되는 응답 항목을 정의합니다.

Name	형식	Description
count	integer	일치하는 패키지의 총 수입니다.
facets	object	각 패싯에 대해 개체 배열 `Filter` 을 저장하는 사전입니다.
infoCode	integer	추가 정보를 나타내는 숫자 코드: 0 - 확인, 1 - 계정이 다시 인덱싱되고 있습니다. 2 - 계정 인덱싱이 시작되지 않음, 3 - 잘못된 요청, 4 - 접두사 와일드카드 쿼리가 지원되지 않음, 5 - 코드 패싯이 지원되지 않는 MultiWords, 6 - 계정이 온보딩되고 있습니다, 7 - 계정이 온보딩되거나 다시 인덱싱되고, 8 - 최대 업데이트 허용 9로 트리밍된 최상위 값 - 분기가 인덱싱되고 있습니다. 10 - 패싯을 사용할 수 없음, 11 - 작업 항목에 액세스할 수 없음, 19 - 코드 형식 필터가 지원되지 않는 구 쿼리, 20 - 코드 형식 필터가 지원되지 않는 와일드카드 쿼리. 다른 정보 코드는 내부 용도로 사용됩니다.
results	PackageResult[]	일치하는 패키지 목록입니다.

SortOption

결과를 정렬하는 방법을 정의합니다.

Name	형식	Description
field	string	정렬을 수행할 필드 이름입니다.
sortOrder	string	결과를 정렬해야 하는 순서(ASC/DESC)입니다.

다음을 통해 공유

Package Search Results - Fetch Package Search Results

URI 매개 변수

요청 본문

응답

보안

oauth2

Scopes

예제

Sample Request

Sample Response

정의

FeedInfo

PackageHit

PackageResult

PackageSearchRequest

PackageSearchResponseContent

SortOption

피드백

추가 리소스