Search accross resource or relationship collections in the data partition

Search across resource or relationship collections in the data partition. This endpoint only accept federated search paths, which means that one using an operator it expects the collection type and collection key to be specified in the path. For example, resources.<collectionKey>.<propertyKey>.

post/partitions/{partitionKey}/v1/federated/{collectionKeys}/query

Request

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

Path parameters

partitionKeystring required

The partition from which to execute the query.

collectionKeysstring required

The collections that should be included in the search. Specifying multiple collections is done by separating them with a comma.

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.