CLclinia
Resources

Retrieve a resource from a data partition

Retrieve a resource from a data partition.

get/partitions/{partitionKey}/v1/collections/{collectionKey}/resources/{resourceId}

Request

  • Base URL
    https://.clinia.cloud
  • URL
    https://.clinia.cloud/partitions/{partitionKey}/v1/collections/{collectionKey}/resources/{resourceId}
  • Auth
    API key in header X-Clinia-API-Key

Path parameters

partitionKeystring required
collectionKeystring required
resourceIdstring 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

includesstring[]

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

Response

A successful response.

idstring required

Id of the resource.

typestring required

Type of the resource.

dataobject required

Dynamic data attributes, based on the resource type.

containedobject

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

relativeIdentitiesobject

The relative identities associated with this resource.

includesunknown

Changes

No recorded changes to this operation across all 1 revision of this API.