Search accross resource or relationship collections in the data partition

post

https://{workspaceId}.clinia.cloud/partitions/{partitionKey}/v1/federated/{collectionKeys}/query

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>.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

partitionKey

string

required

The partition from which to execute the query.

collectionKeys

string

required

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

Body Params

semanticQuery

object

A semantic query is a high-level representation of the user's intent.
When specified, it will trigger our query understanding capabilities and generate a query and filter operator that will be applied to the search parameters.

query

An operator that will be used to search the targeted collections. The matching operator will count as part of the ranking.

filter

An operator that will be used to filter the targeted collections. The filtering operator excludes results that do not match the specified criteria.

highlighting

array of strings

highlighting

page

int32

perPage

int32

Defaults to 20

sort

object

ranking

aggregations

array of objects

aggregations

traversedProperties

array of strings

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.

traversedProperties

Responses

200A successful response.

400Returned when the request is malformed or invalid.

404Returned when the resource type does not exist.

413Returned when the payload exceeds the max content size (100kB).