curl --request GET \
--url https://{workspaceId}.clinia.cloud/catalog/v1/partitions \
--header 'X-Clinia-API-Key: <api-key>'{
"meta": {
"numPages": 123,
"page": 123,
"perPage": 123,
"total": 123
},
"data": [
{
"modules": {
"search": "STANDARD"
},
"source": {
"type": "MDM",
"sources": [
"<string>"
],
"collections": [
{
"properties": {},
"mappings": [
{
"source": "<string>",
"type": "<string>",
"propertyMappings": {}
}
],
"key": "<string>",
"traversedProperties": [
"<string>"
],
"reconciliationRules": {
"type": "SYSTEM",
"rules": {}
},
"contained": {}
}
],
"relationships": [
{
"from": {
"profileKey": "<string>",
"includeKey": "<string>"
},
"to": {
"profileKey": "<string>",
"includeKey": "<string>"
},
"relationshipType": "<string>",
"properties": {},
"mappings": [
{
"source": "<string>",
"type": "<string>",
"propertyMappings": {}
}
],
"reconciliationRules": {
"type": "SYSTEM",
"rules": {}
}
}
]
},
"key": "<string>",
"status": "STATUS_READY"
}
]
}List the data partitions.
curl --request GET \
--url https://{workspaceId}.clinia.cloud/catalog/v1/partitions \
--header 'X-Clinia-API-Key: <api-key>'{
"meta": {
"numPages": 123,
"page": 123,
"perPage": 123,
"total": 123
},
"data": [
{
"modules": {
"search": "STANDARD"
},
"source": {
"type": "MDM",
"sources": [
"<string>"
],
"collections": [
{
"properties": {},
"mappings": [
{
"source": "<string>",
"type": "<string>",
"propertyMappings": {}
}
],
"key": "<string>",
"traversedProperties": [
"<string>"
],
"reconciliationRules": {
"type": "SYSTEM",
"rules": {}
},
"contained": {}
}
],
"relationships": [
{
"from": {
"profileKey": "<string>",
"includeKey": "<string>"
},
"to": {
"profileKey": "<string>",
"includeKey": "<string>"
},
"relationshipType": "<string>",
"properties": {},
"mappings": [
{
"source": "<string>",
"type": "<string>",
"propertyMappings": {}
}
],
"reconciliationRules": {
"type": "SYSTEM",
"rules": {}
}
}
]
},
"key": "<string>",
"status": "STATUS_READY"
}
]
}A successful response.
Show child attributes
Show child attributes
MDM, DATA_SOURCE 1Show child attributes
The properties of the partition collection.
The property key must follow the pattern: ^[a-zA-Z0-9-][\w-]{0,61}$.
Show child attributes
Show child attributes
address, attachment, boolean, code, coding, contactpoint, date, datetime, decimal, geopoint, humanname, identifier, instant, integer, markdown, period, reference, symbol, time, uri, url, xhtml, array, object If set to true, the property cannot be set as required in the rules properties, and can only be set by the ingestion pipeline. Any value provided by the user will be ignored.
Description of the property.
Show child attributes
List of possible values for the property: string and number types only.
1An operator that defines when the rule should be applicable. Whenever this operator evaluates to true, the rule will be checked; when it is evaluated to false, the rule is ignored entirely and none of its validation is applied.
Supported operators are: 'eq', 'lt' and 'gt'. TODO: [ENG-4213] Add examples and document [current] and [*]..
Defines a subset of values the property can take. A binding can be defined for a code, a coding, a symbol or an URI property. In the case of a coding, the binding is applied to the code sub-attribute.
Show child attributes
Show child attributes
The strength with which the binding is asserted.
required, preferred Show child attributes
Show child attributes
Show child attributes
List of possible values for the property: string and number types only.
1An operator that defines when the rule should be applicable. Whenever this operator evaluates to true, the rule will be checked; when it is evaluated to false, the rule is ignored entirely and none of its validation is applied.
Supported operators are: 'eq', 'lt' and 'gt'. TODO: [ENG-4213] Add examples and document [current] and [*]..
Show child attributes
Defines a subset of values the property can take. A binding can be defined for a code, a coding, a symbol or an URI property. In the case of a coding, the binding is applied to the code sub-attribute.
Show child attributes
Show child attributes
The strength with which the binding is asserted.
required, preferred The partition collection properties mappings from the mdm collection source profile's.
Show child attributes
The source from which the properties are mapped.
The type of the resource (analogous to the profile key) from which the properties are mapped.
This is used to map the partition collection properties from the source profile properties. The key is the partition property key and the value can be one of the following:
{
simple_partition_property: simple_source_property,
other_simple_partition_property: source_object_property.sub-property
}{
partition_object_property: {
mappingType: OBJECT
propertyMappings: {
sub-property: simple_source_property
other_sub-property: source_object_property.sub-property
}
}
}{
partition_object_array_property: {
mappingType: OBJECT_ARRAY
propertyMappings: {
fromSourceArray: source_object_array_property
propertyMappings: {
sub-property: source_object_array_property_sub-property
other_sub-property: source_object_array_property_object_sub-property.sub-property
}
}
}
}
```.Show child attributes
The key of the mdm collection (analogous to its UnifiedProfile key).
The properties from the relationships or adjacent records that can be queried in the data partition with one of the following formats:
@{includeKey}.{propertyKey} (e.g. @worksAt.startDate).
This allows to query on the property 'startDate' of the relationship 'worksAt'.@{includeKey}.@{resourcetype}.{propertyKey} (e.g. @[email protected]).
This allows to query on the property 'name' of the resource 'clinic' that is related to the record with the relationship 'worksAt'.@{includeKey}.@{resourcetype}.{containedKey}.{propertyKey} (e.g. @[email protected]).
This allows to query on the property 'address' of the contained resource 'location' of the resource 'clinic' that is related to the record with the relationship 'worksAt'
Traversed Properties support only primitive and general-purpose complex Clinia Datatypes, nested properties of a custom datatype can be queried using the dot notation.The reconciliation rules for the partition collection properties.
Show child attributes
Type is SYSTEM.
SYSTEM, CLINIA_FUNCTION The contained resources of the partition collection.
Show child attributes
Show child attributes
The properties of the partition contained resource.
The property key must follow the pattern: ^[a-zA-Z0-9-][\w-]{0,61}$.
Show child attributes
Show child attributes
address, attachment, boolean, code, coding, contactpoint, date, datetime, decimal, geopoint, humanname, identifier, instant, integer, markdown, period, reference, symbol, time, uri, url, xhtml, array, object If set to true, the property cannot be set as required in the rules properties, and can only be set by the ingestion pipeline. Any value provided by the user will be ignored.
Description of the property.
Show child attributes
List of possible values for the property: string and number types only.
1An operator that defines when the rule should be applicable. Whenever this operator evaluates to true, the rule will be checked; when it is evaluated to false, the rule is ignored entirely and none of its validation is applied.
Supported operators are: 'eq', 'lt' and 'gt'. TODO: [ENG-4213] Add examples and document [current] and [*]..
Defines a subset of values the property can take. A binding can be defined for a code, a coding, a symbol or an URI property. In the case of a coding, the binding is applied to the code sub-attribute.
Show child attributes
Show child attributes
The strength with which the binding is asserted.
required, preferred Show child attributes
Show child attributes
Show child attributes
List of possible values for the property: string and number types only.
1An operator that defines when the rule should be applicable. Whenever this operator evaluates to true, the rule will be checked; when it is evaluated to false, the rule is ignored entirely and none of its validation is applied.
Supported operators are: 'eq', 'lt' and 'gt'. TODO: [ENG-4213] Add examples and document [current] and [*]..
Show child attributes
Defines a subset of values the property can take. A binding can be defined for a code, a coding, a symbol or an URI property. In the case of a coding, the binding is applied to the code sub-attribute.
Show child attributes
Show child attributes
The strength with which the binding is asserted.
required, preferred The partition contained properties mappings from the source profile's.
Show child attributes
The source from which the properties are mapped.
The type of the resource (analogous to the profile key) from which the properties are mapped.
This is used to map the partition collection properties from the source profile properties. The key is the partition property key and the value can be one of the following:
{
simple_partition_property: simple_source_property,
other_simple_partition_property: source_object_property.sub-property
}{
partition_object_property: {
mappingType: OBJECT
propertyMappings: {
sub-property: simple_source_property
other_sub-property: source_object_property.sub-property
}
}
}{
partition_object_array_property: {
mappingType: OBJECT_ARRAY
propertyMappings: {
fromSourceArray: source_object_array_property
propertyMappings: {
sub-property: source_object_array_property_sub-property
other_sub-property: source_object_array_property_object_sub-property.sub-property
}
}
}
}
```.Show child attributes
The type of the contained resource. By default the contained key is used.
Show child attributes
The type of the mdm relationship.
The properties of the partition relationship.
The property key must follow the pattern: ^[a-zA-Z0-9-][\w-]{0,61}$.
Show child attributes
Show child attributes
address, attachment, boolean, code, coding, contactpoint, date, datetime, decimal, geopoint, humanname, identifier, instant, integer, markdown, period, reference, symbol, time, uri, url, xhtml, array, object If set to true, the property cannot be set as required in the rules properties, and can only be set by the ingestion pipeline. Any value provided by the user will be ignored.
Description of the property.
Show child attributes
List of possible values for the property: string and number types only.
1An operator that defines when the rule should be applicable. Whenever this operator evaluates to true, the rule will be checked; when it is evaluated to false, the rule is ignored entirely and none of its validation is applied.
Supported operators are: 'eq', 'lt' and 'gt'. TODO: [ENG-4213] Add examples and document [current] and [*]..
Defines a subset of values the property can take. A binding can be defined for a code, a coding, a symbol or an URI property. In the case of a coding, the binding is applied to the code sub-attribute.
Show child attributes
Show child attributes
The strength with which the binding is asserted.
required, preferred Show child attributes
Show child attributes
Show child attributes
List of possible values for the property: string and number types only.
1An operator that defines when the rule should be applicable. Whenever this operator evaluates to true, the rule will be checked; when it is evaluated to false, the rule is ignored entirely and none of its validation is applied.
Supported operators are: 'eq', 'lt' and 'gt'. TODO: [ENG-4213] Add examples and document [current] and [*]..
Show child attributes
Defines a subset of values the property can take. A binding can be defined for a code, a coding, a symbol or an URI property. In the case of a coding, the binding is applied to the code sub-attribute.
Show child attributes
Show child attributes
The strength with which the binding is asserted.
required, preferred The partition relationship properties mappings from the source relationship profile's.
Show child attributes
The source from which the properties are mapped.
The type of the resource (analogous to the profile key) from which the properties are mapped.
This is used to map the partition collection properties from the source profile properties. The key is the partition property key and the value can be one of the following:
{
simple_partition_property: simple_source_property,
other_simple_partition_property: source_object_property.sub-property
}{
partition_object_property: {
mappingType: OBJECT
propertyMappings: {
sub-property: simple_source_property
other_sub-property: source_object_property.sub-property
}
}
}{
partition_object_array_property: {
mappingType: OBJECT_ARRAY
propertyMappings: {
fromSourceArray: source_object_array_property
propertyMappings: {
sub-property: source_object_array_property_sub-property
other_sub-property: source_object_array_property_object_sub-property.sub-property
}
}
}
}
```.Show child attributes
The reconciliation rules for the partition relationship If not specified, the default reconciliation rule is AGGREGATE for array properties and LATEST for non-array properties.
Show child attributes
Type is SYSTEM.
SYSTEM, CLINIA_FUNCTION The status of the data partition.
STATUS_READY, STATUS_STAGE, STATUS_STALE Was this page helpful?