Delen via

Documents - Get

Service:
Search Service
API-versie:
2025-09-01

Hiermee haalt u een document op uit de index.

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

URI-parameters

Name In Vereist Type Description
endpoint
 path True

string

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

Client-API-versie.
$select
 query

string[]

Lijst met veldnamen die voor het document moeten worden opgehaald; Elk veld dat niet wordt opgehaald, ontbreekt in het geretourneerde document.

Aanvraagkoptekst

Name Vereist Type Description
x-ms-client-request-id

string (uuid)

De tracking-ID die is verzonden met het verzoek om te helpen bij het opsporen.

Antwoorden

Name Type Description
200 OK

LookupDocument

Antwoord met het gevraagde document.
Other Status Codes

ErrorResponse

Foutreactie.

Voorbeelden

SearchIndexGetDocument

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.
ErrorDetail

De foutdetails.
ErrorResponse

Foutreactie

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.
type

string

Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout bevat aanvullende informatie.
code

string

De foutcode.
details

ErrorDetail[]

De foutdetails.
message

string

Het foutbericht.
target

string

Het foutdoel.

ErrorResponse

Object

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.