Data models
Introduction
A data model can be defined as a set of data stream templates. It defines all the variables associated with a device or type of entity for its management and monitoring. These variables represent the information about an individual “measure” that evolves over time, and thus define the main features of a data stream. Further details on this concept can be found in the default data model catalogue. This API enables the management of data models.
Comprehensive API actions
Updating a datamodel
Regarding the datastream (templates), the behavior of this request is:
- All new data streams are incorporated into the existing data model.
- For all existing data streams that have been provisioned and are included in the JSON request, all fields can be modified except for the identifier.
- Please note that all datastreams that have already been provisioned and are not present in the JSON request will be removed. This is only the case if they have not previously been collected as datapoint instances. In the event that at least one datastream with previously collected datapoints is not present in the put option, an error is returned for the entire request.
Default data model catalog edition
Although the above fields are restricted from modification, the following fields of the data model can be adjusted:
datamodel.descriptiondatamodel.category.datastream.descriptiondatamodel.category.datastream.storagedatamodel.category.datastream.tagsdatamodel.category.datastream.unitdatamodel.category.datastream.qratingdatamodel.category.datastream.viewsdatamodel.category.datastream.icon
The datamodel.category.datastream.schema field can also be modified, but only for the next datastreams:
provision.device.specificTypeprovision.device.communicationModules[].specificTypeprovision.device.communicationModules[].subscription.specificTypeprovision.device.communicationModules[].subscriber.specificTypeprovision.asset.specificTypedevice.specificTypedevice.communicationModules[].specificTypedevice.communicationModules[].subscription.specificTypedevice.communicationModules[].subscriber.specificType
This is an example of how to modify the schema field of the datastream provision.device.specificType:
{
"identifier":"provision.device.specificType",
"name":"Prov. Specific type",
"period":"PULSE",
"access":"READ",
"schema":{
"type":"string",
"enum":[
"BLOODPRESSURE_SENSOR",
"COMHUB",
"CONCENTRATOR"
]
}
}Deleting a datamodel
It is not possible to delete a data stream if it contains data points that have already been collected.