CLclinia
Search

Search resources of a specific collection in the data partition

Search resources of a specific collection in the data partition.

post/partitions/{partitionKey}/v1/collections/{collectionKey}/query

Request

  • Base URL
    https://.clinia.cloud
  • URL
    https://.clinia.cloud/partitions/{partitionKey}/v1/collections/{collectionKey}/query
  • Auth
    API key in header X-Clinia-API-Key

Path parameters

partitionKeystring required

The partition from which to execute the query.

collectionKeystring required

The collection from which to execute the query.

Request body

highlightingstring[]
pageinteger
perPageinteger
traversedPropertiesstring[]

The properties from the relationships or adjacent records that will be returned in the search response. The wildcard '*' can be used in itself or in combination with a prefix

  • * will return all traversed properties.
  • @worksAt.* will return all traversed properties from the relationship 'worksAt'.
  • @worksAt.@clinic.* will return all traversed properties from an adjacent 'clinic' connected with a 'worksAt' relationship.

Response

A successful response.

Changes

No recorded changes to this operation across all 1 revision of this API.