HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Twin

digital twin item representing an asset, machine, equipment.

Attributes

NameTypeDescription
twin_iduuid.UUIDtechnical id of the twin.
hardware_idstrunique str hardware id (e.g. required in template and ml models 'by_twin').
namestrlogical display name of the Asset.
descriptionstradditional description of the twin item.
parent_iduuid.UUIDtechnical id of the parent twin item.
typeTwinBlockTypetype (area, machine, equipment or flow).
type_iduuid.UUIDtechnical id of the TwinType associated.
twin_typeTwinTypeTwinType object reference (read-only, populated from type_id).
extra_propertiesdictcustom key/value properties dictionary.
latitudefloatfixed latitude of the twin item.
longitudefloatfixed longitude of the twin item.
latitude_iduuid.UUIDtechnical id of a datapoint specifying dynamic latitude of twin.
longitude_iduuid.UUIDtechnical id of a datapoint specifying dynamic longitude of twin.
colorstrhexadecimal code of the color to associate with this twin item.
iconstrlogical id of the icon or svg schema to associate with this twin item.
createdByIduuid.UUIDunique identifier of creating user.
createdDateinttimestamp of created date.
updatedByIduuid.UUIDunique identifier of updating user.
updatedDateinttimestamp of updated date.

Methods

api_id()

return current object id on Web API format.

endpoint()

return endpoint name used to contact backend.

from_json()

load the object from a dict originating of a JSON format.

NameTypeDefaultDescription
objobject to load information from.

set_id()

specify the id_value neutrally

NameTypeDefaultDescription
id_value
return:

to_json()

transform current object into a dict that could be JSONIFY.

NameTypeDefaultDescription
targetstrNone
return: dumpable dict.