Data models

A data model is a set of data stream templates. See default data model catalog for more information.

With this API, you can manage your data models.

Some data models, specially created for device monitoring and management, are already provisioned by default in the platform. The following rules apply to them:

  • It is not possible remove them.
  • Categories can not be add or remove.
  • Data stream of category can not be add or remove.
  • It is not possible change the following fields:
    • datamodel.name
    • datamodel.version
    • datamodel.category.datastream.name
    • datamodel.category.datastream.period
    • datamodel.category.datastream.schema
    • datamodel.category.datastream.access

Default data model catalog edition

Although the above fields are restricted from modification, the following fields of the data model can be adjusted:

  • datamodel.description
  • datamodel.category.datastream.description
  • datamodel.category.datastream.storage
  • datamodel.category.datastream.tags
  • datamodel.category.datastream.unit
  • datamodel.category.datastream.qrating
  • datamodel.category.datastream.views
  • datamodel.category.datastream.icon

The datamodel.category.datastream.schema field can also be modified, but only for the next datastreams:

  • provision.device.specificType
  • provision.device.communicationModules[].specificType
  • provision.device.communicationModules[].subscription.specificType
  • provision.device.communicationModules[].subscriber.specificType
  • provision.asset.specificType
  • device.specificType
  • device.communicationModules[].specificType
  • device.communicationModules[].subscription.specificType
  • device.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"
      ]
   }
}

API specification