Browse accross resource or relationship collections in the registry

curl --request POST \
  --url https://{workspaceId}.clinia.cloud/sources/{sourceKey}/v1/browse \
  --header 'Content-Type: application/json' \
  --header 'X-Clinia-API-Key: <api-key>' \
  --data '
{
  "collectionKeys": [
    "<string>"
  ],
  "params": {
    "cursor": "<string>",
    "filter": {
      "and": "<array>",
      "id": "<string>"
    },
    "properties": {
      "include": [
        "<string>"
      ],
      "exclude": [
        "<string>"
      ]
    },
    "perPage": 123
  }
}
'

{
  "hits": [
    {
      "hitType": "RESOURCE",
      "score": 123,
      "resource": {},
      "traversedProperties": {},
      "highlighting": {}
    }
  ],
  "meta": {
    "cursor": "<string>",
    "total": 123
  }
}

Browse

Browse accross resource or relationship collections in the registry

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

In order to initiate a browse session, you can specifiy in the body the v1BrowseParameters object with the following properties:

filter: A filter to apply to the browse session. Can contain any valid search operators (all except KNN).
perPage: The number of results to return per batch. Defaults to 100.

Once the browse session is initiated, you can use the cursor returned in the response to continue browsing through the results. The cursor is a string that keeps track of the current position in the browse session and can be used to fetch the next batch of results.

A browse session lives for 5 minutes, after which it will be automatically closed and a 404 error will be returned if you try to continue browsing. The session is a rolling session, meanining that each new request will extend the session by 5 minutes from the time of the request.

A browse response contains the following properties:

hits: An array of results that match the browse session.
meta: An object containing metadata about the browse session, including the cursor and the total number of results available in the browse session.

You should use the hits length to check if there are more results to browse. If hits > 0 is true, you can use the meta.cursor to fetch the next batch of results. If hits > 0 is false, it means that you have reached the end of the browse session and there are no more results to browse.

POST

sources

{sourceKey}

browse

Browse accross resource or relationship collections in the registry

curl --request POST \
  --url https://{workspaceId}.clinia.cloud/sources/{sourceKey}/v1/browse \
  --header 'Content-Type: application/json' \
  --header 'X-Clinia-API-Key: <api-key>' \
  --data '
{
  "collectionKeys": [
    "<string>"
  ],
  "params": {
    "cursor": "<string>",
    "filter": {
      "and": "<array>",
      "id": "<string>"
    },
    "properties": {
      "include": [
        "<string>"
      ],
      "exclude": [
        "<string>"
      ]
    },
    "perPage": 123
  }
}
'

{
  "hits": [
    {
      "hitType": "RESOURCE",
      "score": 123,
      "resource": {},
      "traversedProperties": {},
      "highlighting": {}
    }
  ],
  "meta": {
    "cursor": "<string>",
    "total": 123
  }
}

Authorizations

X-Clinia-API-Key

string

header

required

Path Parameters

sourceKey

string

required

The source from which to execute the query.

Body

application/json

collectionKeys

string[]

required

The collection keys to which the browse session applies.

params

object

required

Parameters to initiate a browse session. This object can contain a filter, a sort, and the number of results to return per page. The perPage property specifies the number of results to return per page, with a default value of 100 and a maximum of 1000.

Show child attributes

params.cursor

string

The cursor to continue browsing from. If not provided, the browse session will start from the beginning by applying the params.

params.filter

object

Logical (and, or, not, all, any), composite (composite), comparisons (eq, gt, lt), text match (match with types phrase, phrasePrefix, word, wordPrefix and optional fuzziness up to 3), geo (geoDistance), and vector (knn).

Show child attributes

params.filter.and

array

required

params.filter.id

string

params.properties

object

Properties selector allows to specify which properties should be included or excluded in the search response. System properties are always included and cannot be excluded. Exclude properties has precedence over include properties.

Show child attributes

params.properties.include

string[]

The properties to include in the search response. System properties are included by default.

params.properties.exclude

string[]

The properties to exclude from the search response. System properties are not allowed to be excluded.

params.perPage

integer<int32>

The number of results to return per page. Defaults to 100.

Required range: x <= 1000

Response

A successful response containting the first batch of results and a cursor to continue browsing. 5 minutes after the request, the cursor will expire and a 404 error will be returned if you try to continue browsing.

hits

object[]

required

Show child attributes

hits.hitType

enum<string>

required

Available options:

RESOURCE,

RELATIONSHIP,

OBJECT,

CONCEPT,

PIPELINE_EXECUTION,

RESOLUTION_QUEUED_ITEM

hits.score

number<double>

required

The score of the hit in the search results, indicating its relevance.

hits.resource

object

required

hits.traversedProperties

object

Show child attributes

hits.traversedProperties.{key}

object[]

Show child attributes

hits.traversedProperties.{key}.type

enum<string>

required

Available options:

address,

attachment,

boolean,

code,

coding,

contactpoint,

date,

datetime,

decimal,

geopoint,

humanname,

identifier,

instant,

integer,

markdown,

period,

reference,

symbol,

time,

uri,

url,

xhtml,

array,

object

hits.traversedProperties.{key}.value

object

required

hits.traversedProperties.{key}.relationshipId

string

hits.traversedProperties.{key}.relationshipType

string

hits.traversedProperties.{key}.recordId

string

hits.traversedProperties.{key}.recordType

string

hits.highlighting

object

Show child attributes

hits.highlighting.{key}

object[]

Option 1
Option 2

Show child attributes

hits.highlighting.{key}.type

enum<string>

required

Available options:

textual,

vector

hits.highlighting.{key}.highlight

string

required

AI Endpoints

Data Catalog Endpoints

Data Partition Endpoints

MDM Endpoints

Registry Endpoints

Terminology Endpoints

Browse accross resource or relationship collections in the registry

Authorizations

Path Parameters

Body

Response