Documents - Get

Služba:: Search Service

Verze rozhraní API:: 2026-05-01-preview

Načte dokument z rejstříku.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)	Adresa URL koncového bodu vyhledávací služby.
indexName	path	True	string	Název indexu.
key	path	True	string	Klíč dokumentu, který chcete načíst.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
$select	query		string[]	Seznam názvů polí pro načtení dokumentu; V vrácených dokumentech nebude chybět žádné pole, které se nenačte.

Hlavička požadavku

Name	Typ	Description
Accept	Accept	Hlavička Accept.
x-ms-query-source-authorization	string	Token identifikující uživatele, pro kterého je dotaz prováděn. Tento token se používá k vynucení bezpečnostních omezení dokumentů.
x-ms-enable-elevated-read	boolean	Hodnota, která umožňuje zvýšené čtení a obejde kontrolu oprávnění na úrovni dokumentu pro dotazovací operaci.
x-ms-client-request-id	string (uuid)	Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.

Odpovědi

Name	Typ	Description
200 OK	LookupDocument	Požadavek byl úspěšný.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

api-key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Rozsahy

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

Příklady

SearchIndexGetDocument

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 200

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

Definice

Name	Description
Accept	Hlavička Accept.
ErrorAdditionalInfo	Další informace o chybě při správě prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

Accept

Výčet

Hlavička Accept.

Hodnota	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Objekt

Další informace o chybě při správě prostředků

Name	Typ	Description
info		Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

Name	Typ	Description
error	ErrorDetail	Objekt chyby.