v3

latestOpenAPI 3.1.02026-08-01389986.6 KB

Record

Conditional get

Returns records from a collection and includes the OCC read token for conditional transactions.

post/api/v2/tenants/{tenant}/databases/{database}/collections/{collection_id}/conditional/get

tenantstring required

Tenant UUID

databasestring required

Database name

collection_idstring required

Collection UUID

{"stackTrail":"components:schemas:ConditionalGetRequestPayload:allOf:properties:where","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:ConditionalGetRequestPayload:allOf:properties:where_document","oasType":"schema","type":"unknown"}

idsstring[] nullable

includeInclude[]

limitinteger nullable

offsetinteger nullable

read_tokeninteger nullable

Records retrieved from the collection

documentsstring[] nullable

idsstring[] required

includeInclude[] required

metadatasHashMap[] nullable

read_tokeninteger required

urisstring[] nullable