Skip to main content
GET
/
partitions
/
{partitionKey}
/
v1
/
collections
/
{collectionKey}
/
resources
/
{resourceId}
Retrieve a resource from a data partition
curl --request GET \
  --url https://{workspaceId}.clinia.cloud/partitions/{partitionKey}/v1/collections/{collectionKey}/resources/{resourceId} \
  --header 'X-Clinia-API-Key: <api-key>'
{
  "id": "<string>",
  "type": "<string>",
  "meta": {
    "createdAt": "2023-11-07T05:31:56Z",
    "identifier": [
      "<any>"
    ],
    "source": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "data": {},
  "contained": {},
  "relativeIdentities": {},
  "includes": {}
}

Authorizations

​
X-Clinia-API-Key
string
header
required

Path Parameters

​
partitionKey
string
required
​
collectionKey
string
required
​
resourceId
string
required

The resource ID. Can also be an identifier with one of the following formats:

  • source:{sourceRecordId}:{sourceKey}.{sourceRecordType} (e.g. source:123:mySourceA.clinic). This is useful to fetch a record when knowing its source record id.
  • mdm:{unifiedRecordId}:old (e.g. mdm:123:old). This is useful to fetch a unified record id that does not exist anymore after being merged.

Query Parameters

​
includes
string[]

List of relationship property key (included resources) to includes with the response.

Response

A successful response.

The included resources or relationships. All odd number of path segments are relationships, and all even number of path segments are resources.

​
id
string
required

Id of the resource.

​
type
string
required

Type of the resource.

​
data
object
required

Dynamic data attributes, based on the resource type.

​
includes
object
​
meta
object
​
contained
object

Resources contained in this top-level resource. Contained resources exists only within the context of this top-level resource.

​
relativeIdentities
object

The relative identities associated with this resource.

⌘I