Code Search Results - Fetch Code Search Results

  • リファレンス
Service:
Search
API Version:
7.1-preview.1

検索テキストの結果のセットを提供します。

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

URI パラメーター

名前 / 必須 型 説明
organization
 path True

string

Azure DevOps 組織の名前です。
project
 path

string

プロジェクト ID またはプロジェクト名
api-version
 query True

string

使う API のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.1' に設定する必要があります。

要求本文

名前 型 説明
$orderBy

SortOption[]

検索結果を並べ替えるオプション。 null に設定すると、結果は関連性で並べ替えて返されます。 複数の並べ替えオプションが指定されている場合、結果は OrderBy で指定された順序で並べ替えられます。
$skip

integer

スキップする結果の数。
$top

integer

返される結果の数。
filters

object

適用するフィルター。 適用するフィルターがない場合は、null に設定します。
includeFacets

boolean

結果のファセットを選択するフラグ。 既定の動作は false です。
includeSnippet

boolean

結果に一致するコード スニペットを含めるのを選択するフラグ。 既定の動作は false です。
searchText

string

検索文字列。

応答

名前 型 説明
200 OK

CodeSearchResponse

成功した操作

セキュリティ

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

名前 説明
vso.code コミット、変更セット、ブランチ、およびその他のバージョン管理成果物に関するソース コードとメタデータを読み取る機能を付与します。 また、サービス フックを使用してコードを検索し、バージョン管理イベントに関する通知を受け取る機能も付与されます。

例

Sample Request

POST https://almsearch.dev.azure.com/fabrikam/_apis/search/codesearchresults?api-version=7.1-preview.1

{
  "searchText": "CodeSearchController",
  "$skip": 0,
  "$top": 1,
  "filters": {
    "Project": [
      "MyFirstProject"
    ],
    "Repository": [
      "MyFirstProject"
    ],
    "Path": [
      "/"
    ],
    "Branch": [
      "master"
    ],
    "CodeElement": [
      "def",
      "class"
    ]
  },
  "$orderBy": [
    {
      "field": "filename",
      "sortOrder": "ASC"
    }
  ],
  "includeFacets": true
}

Sample Response

Status code:
200 
{
  "count": 1,
  "results": [
    {
      "fileName": "CodeSearchController.cs",
      "path": "/CodeSearchController.cs",
      "matches": {
        "content": [
          {
            "charOffset": 1187,
            "length": 20
          },
          {
            "charOffset": 1395,
            "length": 20
          },
          {
            "charOffset": 1686,
            "length": 20
          }
        ],
        "fileName": [
          {
            "charOffset": 0,
            "length": -1
          }
        ]
      },
      "collection": {
        "name": "DefaultCollection"
      },
      "project": {
        "name": "MyFirstProject",
        "id": "00000000-0000-0000-0000-000000000000"
      },
      "repository": {
        "name": "MyFirstProject",
        "id": "c1548045-29f6-4354-8114-55ef058be1a3",
        "type": "git"
      },
      "versions": [
        {
          "branchName": "master",
          "changeId": "47e1cc8877baea4b7bb33af803d6cc697914f88b"
        }
      ],
      "contentId": "004898f1ad91c9c2a0f492f2d1174468bc3c84ef"
    }
  ],
  "infoCode": 0,
  "facets": {
    "Project": [
      {
        "name": "MyFirstProject",
        "id": "MyFirstProject",
        "resultCount": 1
      }
    ],
    "Repository": [
      {
        "name": "MyFirstProject",
        "id": "MyFirstProject",
        "resultCount": 1
      }
    ],
    "CodeElement": [
      {
        "name": "Class",
        "id": "class",
        "resultCount": 1
      },
      {
        "name": "Comment",
        "id": "comment",
        "resultCount": 1
      },
      {
        "name": "Definition",
        "id": "def",
        "resultCount": 1
      }
    ]
  }
}

定義

名前 説明
CodeResult

検索されたファイルとそのメタデータの情報を含むコード結果を定義します。
CodeSearchRequest

コード検索要求を定義します。
CodeSearchResponse

コード検索応答項目を定義します。
Collection

コレクションの詳細を定義します。
Project

プロジェクトの詳細を定義します。
Repository

リポジトリの詳細を定義します。
SortOption

結果を並べ替える方法を定義します。
Version

結果ファイルのバージョンに関連する詳細について説明します。
VersionControlType

結果ファイルのバージョン管理の種類。

CodeResult

検索されたファイルとそのメタデータの情報を含むコード結果を定義します。

名前 型 説明
collection

Collection

結果ファイルのコレクション。
contentId

string

結果ファイルの ContentId。
fileName

string

結果ファイルの名前。
matches

object

結果ファイル内のオフセットをヒットするフィールドのディクショナリ。 キーは、ヒットが見つかった領域を識別します。たとえば、ファイルの内容やファイル名などです。
path

string

結果ファイルが存在するパス。
project

Project

結果ファイルのプロジェクト。
repository

Repository

結果ファイルのリポジトリ。
versions

Version[]

結果ファイルのバージョン。

CodeSearchRequest

コード検索要求を定義します。

名前 型 説明
$orderBy

SortOption[]

検索結果を並べ替えるオプション。 null に設定すると、結果は関連性で並べ替えて返されます。 複数の並べ替えオプションが指定されている場合、結果は OrderBy で指定された順序で並べ替えられます。
$skip

integer

スキップする結果の数。
$top

integer

返される結果の数。
filters

object

適用するフィルター。 適用するフィルターがない場合は、null に設定します。
includeFacets

boolean

結果のファセットを選択するフラグ。 既定の動作は false です。
includeSnippet

boolean

結果に一致するコード スニペットを含めるのを選択するフラグ。 既定の動作は false です。
searchText

string

検索文字列。

CodeSearchResponse

コード検索応答項目を定義します。

名前 型 説明
count

integer

一致するファイルの合計数。
facets

object

各ファセットに対する オブジェクトの Filter 配列を格納するディクショナリ。
infoCode

integer

追加情報を示す数値コード: 0 - OK、1 - アカウントのインデックス再作成中、2 - アカウントのインデックス作成が開始されていません、3 - 無効な要求、4 - プレフィックスワイルドカード クエリがサポートされていません、5 - コード ファセットがサポートされていないマルチワード、6 - アカウントがオンボード中、7 - アカウントがオンボードまたはインデックス再作成中、8 - maxresult にトリミングされた上位値が許可されている 9 - ブランチのインデックス作成、 10 - ファセットが有効になっていない、11 - 作業項目にアクセスできない、19 - コード型フィルターがサポートされていないフレーズ クエリ、20 - コード型フィルターを含むワイルドカード クエリはサポートされていません。 その他の情報コードは、内部目的で使用されます。
results

CodeResult[]

一致するファイルの一覧。

Collection

コレクションの詳細を定義します。

名前 型 説明
name

string

コレクションの名前。

Project

プロジェクトの詳細を定義します。

名前 型 説明
id

string

プロジェクトの ID。
name

string

プロジェクトの名前。

Repository

リポジトリの詳細を定義します。

名前 型 説明
id

string

リポジトリの ID。
name

string

リポジトリの名前。
type

VersionControlType

結果ファイルのバージョン管理の種類。

SortOption

結果を並べ替える方法を定義します。

名前 型 説明
field

string

並べ替えを行うフィールド名。
sortOrder

string

結果を並べ替える順序 (ASC/DESC)。

Version

結果ファイルのバージョンに関連する詳細について説明します。

名前 型 説明
branchName

string

ブランチの名前。
changeId

string

この一致に関連付けられている特定のブランチの ChangeId。

VersionControlType

結果ファイルのバージョン管理の種類。

名前 型 説明
custom

string

内部使用です。
git

string

tfvc

string