HomeGuidesAPI ReferenceChangelog
Log In
API Reference

TwinType

defines a custom twin type with visual properties.

Attributes

NameTypeDescription
twin_type_iduuid.UUIDtechnical id of the twin type.
namestrdisplay name of the twin type.
iconstrlogical id of the icon to associate with this type.
colorstrhexadecimal color code.
descriptionstrdescription of the twin type.
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.