次の方法で共有

Documents - Get

サービス:
Search Service
API バージョン:
2025-09-01

インデックスからドキュメントを取得します。

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2025-09-01
省略可能なパラメーターを含む: 
GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2025-09-01

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string

検索サービスのエンドポイント URL。
indexName
 path True

string

インデックスの名前です。
key
 path True

string

取得するドキュメントのキー。
api-version
 query True

string

クライアント API のバージョン。
$select
 query

string[]

ドキュメントに対して取得するフィールド名のリスト。取得されなかったフィールドは、返されるドキュメントから欠落します。

要求ヘッダー

名前 必須 型 説明
x-ms-client-request-id

string (uuid)

デバッグを支援するためにリクエストとともに送信されたトラッキング ID。

応答

名前 型 説明
200 OK

LookupDocument

要求されたドキュメントを含む応答。
Other Status Codes

ErrorResponse

エラー応答。

例

SearchIndexGetDocument

要求のサンプル

GET https://stableexampleservice.search.windows.net/indexes('stable-test')/docs('1')?$select=id,description,name,category,ownerId&api-version=2025-09-01

応答のサンプル

状態コード:
200 
{
  "id": "1",
  "name": "test",
  "description": "test1 hello",
  "category": "purple",
  "ownerId": "sam"
}

定義

名前 説明
ErrorAdditionalInfo

リソース管理エラーの追加情報。
ErrorDetail

エラーの詳細。
ErrorResponse

エラー応答

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細。
message

string

エラー メッセージ。
target

string

エラーターゲット。

ErrorResponse

Object

エラー応答

名前 型 説明
error

ErrorDetail

エラー オブジェクト。