HomeGuidesAPI ReferenceChangelog
Log In
API Reference

GroupSystem

defines a group system for organizing datapoints into logical groups.

Attributes

NameTypeDescription
group_system_iduuid.UUIDtechnical id of the group system.
keystrunique logical key.
namestrdisplay name of the group system.
descriptionstrdescription of the group system.

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.