Browse accross resource or relationship collections in the data partition

curl --request POST \
  --url https://api.{workspaceId}.clinia.cloud/partitions/{partitionKey}/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
  }
}
'

import requests

url = "https://api.{workspaceId}.clinia.cloud/partitions/{partitionKey}/v1/browse"

payload = {
    "collectionKeys": ["<string>"],
    "params": {
        "cursor": "<string>",
        "filter": {
            "and": "<array>",
            "id": "<string>"
        },
        "properties": {
            "include": ["<string>"],
            "exclude": ["<string>"]
        },
        "perPage": 123
    }
}
headers = {
    "X-Clinia-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Clinia-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    collectionKeys: ['<string>'],
    params: {
      cursor: '<string>',
      filter: {and: '<array>', id: '<string>'},
      properties: {include: ['<string>'], exclude: ['<string>']},
      perPage: 123
    }
  })
};

fetch('https://api.{workspaceId}.clinia.cloud/partitions/{partitionKey}/v1/browse', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.{workspaceId}.clinia.cloud/partitions/{partitionKey}/v1/browse",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'collectionKeys' => [
        '<string>'
    ],
    'params' => [
        'cursor' => '<string>',
        'filter' => [
                'and' => '<array>',
                'id' => '<string>'
        ],
        'properties' => [
                'include' => [
                                '<string>'
                ],
                'exclude' => [
                                '<string>'
                ]
        ],
        'perPage' => 123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Clinia-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.{workspaceId}.clinia.cloud/partitions/{partitionKey}/v1/browse"

	payload := strings.NewReader("{\n  \"collectionKeys\": [\n    \"<string>\"\n  ],\n  \"params\": {\n    \"cursor\": \"<string>\",\n    \"filter\": {\n      \"and\": \"<array>\",\n      \"id\": \"<string>\"\n    },\n    \"properties\": {\n      \"include\": [\n        \"<string>\"\n      ],\n      \"exclude\": [\n        \"<string>\"\n      ]\n    },\n    \"perPage\": 123\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Clinia-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.{workspaceId}.clinia.cloud/partitions/{partitionKey}/v1/browse")
  .header("X-Clinia-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"collectionKeys\": [\n    \"<string>\"\n  ],\n  \"params\": {\n    \"cursor\": \"<string>\",\n    \"filter\": {\n      \"and\": \"<array>\",\n      \"id\": \"<string>\"\n    },\n    \"properties\": {\n      \"include\": [\n        \"<string>\"\n      ],\n      \"exclude\": [\n        \"<string>\"\n      ]\n    },\n    \"perPage\": 123\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.{workspaceId}.clinia.cloud/partitions/{partitionKey}/v1/browse")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Clinia-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"collectionKeys\": [\n    \"<string>\"\n  ],\n  \"params\": {\n    \"cursor\": \"<string>\",\n    \"filter\": {\n      \"and\": \"<array>\",\n      \"id\": \"<string>\"\n    },\n    \"properties\": {\n      \"include\": [\n        \"<string>\"\n      ],\n      \"exclude\": [\n        \"<string>\"\n      ]\n    },\n    \"perPage\": 123\n  }\n}"

response = http.request(request)
puts response.read_body

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

{
  "message": "<string>",
  "details": "<array>",
  "additionalContext": {}
}

{
  "message": "<string>",
  "details": "<array>",
  "additionalContext": {}
}

{
  "message": "<string>",
  "details": "<array>",
  "additionalContext": {}
}

{
  "message": "<string>",
  "details": "<array>",
  "additionalContext": {}
}

Browse

Browse accross resource or relationship collections in the data partition

Browse across resource or relationship collections in the data partition. 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

partitions

{partitionKey}

browse

Browse accross resource or relationship collections in the data partition

curl --request POST \
  --url https://api.{workspaceId}.clinia.cloud/partitions/{partitionKey}/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
  }
}
'

import requests

url = "https://api.{workspaceId}.clinia.cloud/partitions/{partitionKey}/v1/browse"

payload = {
    "collectionKeys": ["<string>"],
    "params": {
        "cursor": "<string>",
        "filter": {
            "and": "<array>",
            "id": "<string>"
        },
        "properties": {
            "include": ["<string>"],
            "exclude": ["<string>"]
        },
        "perPage": 123
    }
}
headers = {
    "X-Clinia-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Clinia-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    collectionKeys: ['<string>'],
    params: {
      cursor: '<string>',
      filter: {and: '<array>', id: '<string>'},
      properties: {include: ['<string>'], exclude: ['<string>']},
      perPage: 123
    }
  })
};

fetch('https://api.{workspaceId}.clinia.cloud/partitions/{partitionKey}/v1/browse', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.{workspaceId}.clinia.cloud/partitions/{partitionKey}/v1/browse",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'collectionKeys' => [
        '<string>'
    ],
    'params' => [
        'cursor' => '<string>',
        'filter' => [
                'and' => '<array>',
                'id' => '<string>'
        ],
        'properties' => [
                'include' => [
                                '<string>'
                ],
                'exclude' => [
                                '<string>'
                ]
        ],
        'perPage' => 123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Clinia-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.{workspaceId}.clinia.cloud/partitions/{partitionKey}/v1/browse"

	payload := strings.NewReader("{\n  \"collectionKeys\": [\n    \"<string>\"\n  ],\n  \"params\": {\n    \"cursor\": \"<string>\",\n    \"filter\": {\n      \"and\": \"<array>\",\n      \"id\": \"<string>\"\n    },\n    \"properties\": {\n      \"include\": [\n        \"<string>\"\n      ],\n      \"exclude\": [\n        \"<string>\"\n      ]\n    },\n    \"perPage\": 123\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Clinia-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.{workspaceId}.clinia.cloud/partitions/{partitionKey}/v1/browse")
  .header("X-Clinia-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"collectionKeys\": [\n    \"<string>\"\n  ],\n  \"params\": {\n    \"cursor\": \"<string>\",\n    \"filter\": {\n      \"and\": \"<array>\",\n      \"id\": \"<string>\"\n    },\n    \"properties\": {\n      \"include\": [\n        \"<string>\"\n      ],\n      \"exclude\": [\n        \"<string>\"\n      ]\n    },\n    \"perPage\": 123\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.{workspaceId}.clinia.cloud/partitions/{partitionKey}/v1/browse")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Clinia-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"collectionKeys\": [\n    \"<string>\"\n  ],\n  \"params\": {\n    \"cursor\": \"<string>\",\n    \"filter\": {\n      \"and\": \"<array>\",\n      \"id\": \"<string>\"\n    },\n    \"properties\": {\n      \"include\": [\n        \"<string>\"\n      ],\n      \"exclude\": [\n        \"<string>\"\n      ]\n    },\n    \"perPage\": 123\n  }\n}"

response = http.request(request)
puts response.read_body

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

{
  "message": "<string>",
  "details": "<array>",
  "additionalContext": {}
}

{
  "message": "<string>",
  "details": "<array>",
  "additionalContext": {}
}

{
  "message": "<string>",
  "details": "<array>",
  "additionalContext": {}
}

{
  "message": "<string>",
  "details": "<array>",
  "additionalContext": {}
}

Authorizations

X-Clinia-API-Key

string

header

required

Path Parameters

partitionKey

string

required

The partition 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

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

Data Catalog Endpoints

Data Partition Endpoints

MDM Endpoints

Registry Endpoints

Terminology Endpoints

Operations Endpoints

AI Engine

Browse accross resource or relationship collections in the data partition

Authorizations

Path Parameters

Body

Response