roboto.domain.devices.record

Module Contents

DeviceRecord

class roboto.domain.devices.record.DeviceRecord(/, **data)#

Bases: pydantic.BaseModel

A wire-transmissible representation of a device.

This record contains all the essential information about a device that can be transmitted over the network. It includes metadata about when the device was created and modified, along with its organizational association.

Parameters

data Any

Attributes

DeviceRecord.created

created datetime.datetime #

Date/time when this device was registered.

DeviceRecord.created_by

created_by str #

The user who registered this device.

DeviceRecord.custom_fields

custom_fields dict[str, Any] = None #

Values for the custom fields defined on Devices in this org.

Every Ready custom field defined for (org_id, Device) appears as a key; values that have not been set surface as None rather than being absent. Empty when no custom fields are defined for the org.

DeviceRecord.device_id

device_id str #

A user-provided identifier for a device, which is unique within that device’s org.

DeviceRecord.metadata

metadata dict[str, Any] = None #

Key-value metadata pairs associated with this device.

DeviceRecord.modified

modified datetime.datetime #

Date/time when this device record was last modified.

DeviceRecord.modified_by

modified_by str #

The user who last modified this device record.

DeviceRecord.org_id

org_id str #

The org to which this device belongs.

DeviceRecord.tags

tags list[str] = None #

List of tags associated with this device.

DeviceRecord.universal_device_id

universal_device_id str | None = None #

A Roboto-assigned identifier for a device (dv_...), unique across all orgs and never changed.

Use this ID, not device_id, with device(). None only when talking to a Roboto deployment that predates it.