Documents - Get

Služba:

Search Service

Verze rozhraní API:

2025-09-01

Načte dokument z rejstříku.

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2025-09-01

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	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	Verze rozhraní API klienta.
$select	query		string[]	Seznam názvů polí, které se mají načíst pro dokument; Každé pole, které nebylo načteno, bude ve vráceném dokumentu chybět.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string (uuid)	ID sledování odeslané s požadavkem na pomoc s laděním.

Odpovědi

Name	Typ	Description
200 OK	LookupDocument	Odpověď obsahující požadovaný dokument.
Other Status Codes	ErrorResponse	Chybová odpověď.

Příklady

SearchIndexGetDocument

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

200

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

Definice

Name	Description
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	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

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.