Skip to content

GitLab

Last edited by Jurjen Brouwer
Page history
This is an old version of this page. You can view the most recent version or browse the history.

Robot API

Info

Get the document of a particular robot.

https://portal.robotsindeklas.nl/API/v1/robot/info

Parameter:

  • robot, string: the object id of the robot you want the info of.

Lock

Lock a robot. If a robot is locked, users with play or edit rights will no longer have access to this robot.

https://portal.robotsindeklas.nl/API/v1/robot/lock

Parameters:

  • robot, string: the object id of the robot you want to lock;
  • lock, boolean, (optional, default: false): lock (true) or unlock (false) this robot.

Share

Share a robot with a user or group. We define four levels of share rights:

  • 0 (revoked rights): user or group will no longer have access to this robot;
  • 1 (play rights): user or group is only allowed to play apps on this robot;
  • 2 (edit rights): user or group is allowed to play apps on this robot and adjust the settings;
  • 3 (admin rights): user or group is allowed to play apps, adjust settings, and further share this robot with other users.
https://portal.robotsindeklas.nl/API/v1/robot/share

Parameters:

  • robot, string: the object id of the robot you want to share;
  • level, int: the share level we want to assign to the user or group with this request;
  • oid, string: the object id of the user or group we want the share this robot with.