Usage Guideline + Authenticati...
Digital Twins
8min
the digital twins module handles all operations in the digital twins service and supports all the same functionality that is possible via the ui of litmus edge general version get digital twin service version and git commit schema introspection get gql schema of digital twins api models all models have the following properties id , name , description , and type list models get a list of all models update model update name, description, or type of model create model create model, returns the id of the model if successful clone model clone an existing model from id delete model delete model specified by id export model export a model and all properties associated with the model (attributes, hierarchy, etc ) import model import a model and all associated properties instances an instance of an existing model instances have the following properties id , model id , name , topic , interval and flat hierarchy list all instances get all instances in the edge instance get instance by model get all instances of a model create instance create an instance for a model update instance update name, topic, interval, or flat hierarchy configuration of an instance set instance state enable or disable an instance delete instance delete an instance by id upgrade instances update an instance to match the configuration of its model if deviated dynamic attributes both models and instances can have dynamic attributes all operations can act either on a model or instance based on whether instance id or model id is set all dynamic attributes have the following properties id , name , unit , datatype , schema id , topic list dynamic attributes get all dynamic attributes of a model or instance create dynamic attribute create for a model update dynamic attribute update for a model or instance delete dynamic attribute delete dynamic attribute static attributes both models and instances can have static attributes all operations can act either on a model or instance based on whether instance id or model id is set all static attributes have the following properties id , name , value list static attributes get all static attributes of a model or instance create static attributes create for a model update static attributes update for a model or instance delete static attributes delete static attribute, or list of static attributes transformations transformations only exist for models and have a name and schema which is json specified by dictionary object list transformations get all transformations of a model create transformations create for a model update transformations update name or schema delete transformations delete individual transformation hierarchy json specified hierarchy specified by dictionary get hierarchy get hierarchy of model `save hierarchy set hierarchy of model