Documents - Get

Service:: Search Service

API-versie:: 2026-08-01-preview

Hiermee haalt u een document op uit de index.

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2026-08-01-preview

Met optionele parameters:

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2026-08-01-preview&$select={$select}

URI-parameters

Naam	In	Vereist	Type	Description
endpoint	path	True	string (uri)	De eindpunt-URL van de zoekservice.
indexName	path	True	string	De naam van de index.
key	path	True	string	De sleutel van het document op te halen.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
$select	query		string[]	Lijst met veldnamen die moeten worden opgehaald voor het document; Een veld dat niet wordt opgehaald, ontbreekt in het geretourneerde document.

Aanvraagkoptekst

Naam	Type	Description
x-ms-client-request-id	string (uuid)	Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.
Accept	Accept	De Accepteer kop.
x-ms-query-source-authorization	string (password)	Token dat de gebruiker identificeert waarvoor de query wordt uitgevoerd. Dit token wordt gebruikt om beveiligingsbeperkingen op documenten af te dwingen.
x-ms-enable-elevated-read	boolean	Een waarde die verhoogd lezen mogelijk maakt waarmee machtigingscontroles op documentniveau voor de querybewerking worden overgeslagen.

Antwoorden

Naam	Type	Description
200 OK	LookupDocument	De aanvraag is voltooid.
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Beveiliging

api-key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiken

Naam	Description
https://search.azure.com/.default

Voorbeelden

SearchIndexGetDocument

Voorbeeldaanvraag

HTTP

GET https://typespecpreviewexampleservice.search.windows.net/indexes('preview-test')/docs('1')?api-version=2026-08-01-preview&$select=id,description,name,category,ownerId

Voorbeeldrespons

Statuscode:: 200

{
  "id": "1",
  "name": "test",
  "description": "test1 hello",
  "category": "purple",
  "ownerId": "sam"
}

Definities

Naam	Description
Accept	De Accepteer kop.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	Het foutdetail.
ErrorResponse	Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

Accept

Opsomming

De Accepteer kop.

Waarde	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Naam	Type	Description
info		De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

Het foutdetail.

Naam	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Aanvullende informatie over de fout.
code	string	De foutcode.
details	ErrorDetail[]	De foutgegevens.
message	string	Het foutbericht.
target	string	Het foutdoelwit.

ErrorResponse

Object

Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

Naam	Type	Description
error	ErrorDetail	Het foutobject.