DeviceCreator encapsulates all the information needed to create a new Device in the system. The data provided will be used to seed the new Device and its related information. The clientId field of the Device is used to store the MAC address of the primary network interface of the device. The Device will always be created with connection status disconnected and no last event information. The fields of the DeviceCreator presents the attributes that are searchable for a given device. The DeviceCreator Properties field can be used to provide additional properties associated to the Device; those properties will not be searchable through Device queries. Some of those properties are recognized by the platform and promoted a top level attributes of the Device class.
| name | data type | constraints | description |
|---|---|---|---|
| accountId | number | required | |
| deviceUserId | number | required | |
| clientId | string | ||
| displayName | string | ||
| modelId | string | ||
| serialNumber | string | ||
| imei | string | ||
| imsi | string | ||
| iccid | string | ||
| firmwareVersion | string | ||
| biosVersion | string | ||
| osVersion | string | ||
| jvmVersion | string | ||
| osgiFrameworkVersion | string | ||
| esfVersion | string | ||
| connectionIp | string | ||
| acceptEncoding | string | ||
| applicationIdentifiers | string | ||
| gpsLatitude | number | ||
| gpsLongitude | number | ||
| customAttribute1 | string | ||
| customAttribute2 | string | ||
| customAttribute3 | string | ||
| customAttribute4 | string | ||
| customAttribute5 | string | ||
| properties | string | ||
| signedCertificateId | number | ||
| credentialsTight | DeviceCredentialsTight | ||
| credentialsAllowChange | boolean | required | |
| certificateCommonName | string |
Example
{
"accountId" : 12345,
"deviceUserId" : 12345,
"clientId" : "...",
"displayName" : "...",
"modelId" : "...",
"serialNumber" : "...",
"imei" : "...",
"imsi" : "...",
"iccid" : "...",
"firmwareVersion" : "...",
"biosVersion" : "...",
"osVersion" : "...",
"jvmVersion" : "...",
"osgiFrameworkVersion" : "...",
"esfVersion" : "...",
"connectionIp" : "...",
"acceptEncoding" : "...",
"applicationIdentifiers" : "...",
"gpsLatitude" : 12345.0,
"gpsLongitude" : 12345.0,
"customAttribute1" : "...",
"customAttribute2" : "...",
"customAttribute3" : "...",
"customAttribute4" : "...",
"customAttribute5" : "...",
"properties" : "...",
"signedCertificateId" : 12345,
"credentialsTight" : "INHERITED",
"credentialsAllowChange" : true,
"certificateCommonName" : "..."
}