The Device Object provides a data structure for managing devices of many different types. In particular, it includes fields for networking, IoT and technology devices.
Module: Assets
Collection: Devices
Object Identifier: assets.device
| Friendly Field Name | Data Field Name | General Data Type | Description | Optimised for Searching |
|---|---|---|---|---|
| Unique Identifier | uuid | UUID | Unique identifier for each device | Yes |
| Application Identifier | app_uuid | UUID | Identifier for the associated application | Yes |
| Application Context Reference | app_context_ref | Text (max length 50) | You can use this field to provide searchable context to your object – for example this may be an external identifier, or a lookup UUID to another object in your application. | Yes |
| Sub UUID | sub_uuid | UUID | Similar to the Application Context Ref, This field can be used to store a UUID to another Object. For example, you may be recording an event for an asset – this field would be the preferred field to store the asset UUID to which the event relates. | Yes |
| Linked Device UUID | linked_device_uuid | UUID | Identifier for a parent device, if applicable. The Parent Object must already exist in this Collection, otherwise an error will occur when creating the new Object. | Yes |
| Label | label | Text (max length 50) | Label for the device. | No |
| Device Name | device_name | Text (max length 50) | Name of the device. | No |
| Device Type Key | device_type_key | Text (max length 30) | Key identifying the device type. | No |
| Device Profile Key | device_profile_key | Text (max length 30) | Key for the device profile. | No |
| Make | make | Text (max length 50) | Make of the device. | No |
| Model | model | Text (max length 50) | Model of the device. | No |
| Version | version | Text (max length 50) | Version of the device. | No |
| Hardware Version | hw_version | Text (max length 50) | Hardware version of the device. | No |
| Software Version | sw_version | Text (max length 50) | Software version of the device. | No |
| Serial Number | serial_num | Text (max length 50) | Serial number of the device. | No |
| MAC Address 1 | mac_addr_1 | Text (max length 17) | First MAC address of the device. | No |
| MAC Address 2 | mac_addr_2 | Text (max length 17) | Second MAC address of the device. | No |
| MAC Address 3 | mac_addr_3 | Text (max length 17) | Third MAC address of the device. | No |
| MAC Address 4 | mac_addr_4 | Text (max length 17) | Fourth MAC address of the device. | No |
| IMEI 1 | imei_1 | Text (max length 20) | First IMEI number of the device. | No |
| IMEI 2 | imei_2 | Text (max length 20) | Second IMEI number of the device. | No |
| IMEI 3 | imei_3 | Text (max length 20) | Third IMEI number of the device. | No |
| IMEI 4 | imei_4 | Text (max length 20) | Fourth IMEI number of the device. | No |
| IMSI 1 | imsi_1 | Text (max length 20) | First IMSI number of the device. | No |
| IMSI 2 | imsi_2 | Text (max length 20) | Second IMSI number of the device. | No |
| IMSI 3 | imsi_3 | Text (max length 20) | Third IMSI number of the device. | No |
| IMSI 4 | imsi_4 | Text (max length 20) | Fourth IMSI number of the device. | No |
| MSISDN 1 | msisdn_1 | Text (max length 20) | First MSISDN number of the device. | No |
| MSISDN 2 | msisdn_2 | Text (max length 20) | Second MSISDN number of the device. | No |
| MSISDN 3 | msisdn_3 | Text (max length 20) | Third MSISDN number of the device. | No |
| MSISDN 4 | msisdn_4 | Text (max length 20) | Fourth MSISDN number of the device. | No |
| Custom Field 1 | custom_1 | Text (max length 255) | Custom field for additional information. | No |
| Custom Field 1 Label | custom_1_label | Text (max length 30) | Label for Custom Field 1. | No |
| Custom Field 2 | custom_2 | Text (max length 255) | Custom field for additional information. | No |
| Custom Field 2 Label | custom_2_label | Text (max length 30) | Label for Custom Field 2. | No |
| Custom Field 3 | custom_3 | Text (max length 255) | Custom field for additional information. | No |
| Custom Field 3 Label | custom_3_label | Text (max length 30) | Label for Custom Field 3. | No |
| Custom Field 4 | custom_4 | Text (max length 255) | Custom field for additional information. | No |
| Custom Field 4 Label | custom_4_label | Text (max length 30) | Label for Custom Field 4. | No |
| Custom Field 5 | custom_5 | Text (max length 255) | Custom field for additional information. | No |
| Custom Field 5 Label | custom_5_label | Text (max length 30) | Label for Custom Field 5. | No |
| Meta Data | meta_data | Text | Additional meta data for the device. | No |
| Status | status | Enumerated List | Status of the device (e.g., active, archived). Allowable values are:active, archived, damaged, faulty, in-use, inactive,maintenance, off, offline, on, online, out-of-service,standby, other | No |
| Taxonomy | taxonomy | Text (max length 50) | Internal categorisation for the device. | Yes |
| Created At | created_at | DateTime | Timestamp when the record was created. | No |
| Updated At | updated_at | DateTime | Timestamp when the record was last updated. | No |
| Created By | created_by | Text (max length 50) | You can use this field to record who or what created the Object record. | No |
| Updated By | updated_by | Text (max length 50) | You can use this field to record who or what last updated the Object record. | No |