User GuideAPI Reference
ProductUse CasesResource CenterFAQAbout UsBook a DemoSign Up - It's Free
API Reference

Start Analytics DB Initialization

Start Analytics DB Initialization

The following API starts the process of creating analytics DB. After the process is finished the analytics DB will be available for queries.

This API can be called when analytics DB deployment state is: [DEPLOYED] and activation state is: [INACTIVE, ACTIVE_AND_SYNC_OFF].

After this API is called the activation state will be changed to: [INITIALIZING] and when the analytics DB initialization process is finished the state will be: [ACTIVE_AND_SYNC_ON]

The database structure will be as follow:

The table name will be in the following format:

For entities without parent: {templateName}_{entityTypeName}

Example:
DeviceType1_device

For entities with parent: {templateName}{entityTypeName}{parentTemplateName}_{parentEntityType}

Example:
Reboot_command_DeviceType1_device

For observations: Observations{patientTemplateName}{patientEntityTypeName}

Example:
Observations_Patient_patient

Basically each attribute will have a column or multiple columns (depends on the attribute type)

Examples:

Regular attribute - the column name will be the attribute full path:

 _email --> _email

Object attribute - each field of the object will have a column and the name is the name of the attribute + field:

 _address -> _address.city, _address.state, etc.

File and Image attribute - will have 4 columns: 

[fileAttributeName] --> [fileAttributeName].id, [fileAttributeName].size, [fileAttributeName].name, [fileAttributeName].mimeType

Name attribute - will have 2 columns:

 _name --> _name.firstName, _name.lastName

Reference attribute - will have 2 columns:
 _patient --> _patient.id, _patient.templateName

Each table will have additional columns except for the attribute columns:
_id, _templateName

For observations tables, each table will consist of all observation attributes as well as the following columns: [timestamp, patientId, sessionId, sourceEntityId]
Waveform attributes are represented as integer/decimal columns with explicit value at each interval

All current tables are dropped before starting the init process.

This API requires DMS_START_ANALYTICS_DB_INITIALIZATION permission(s).

Language
Credentials
Bearer
JWT
Click Try It! to start a request and see the response here!