|
### Info
|
|
### Info
|
|
|
|
Get the document of a particular robot.
|
|
```
|
|
```
|
|
https://portal.robotsindeklas.nl/API/v1/robot/info
|
|
https://portal.robotsindeklas.nl/API/v1/robot/info
|
|
```
|
|
```
|
|
|
|
|
|
Parameter:
|
|
Parameter:
|
|
- **robot**: the object id of the robot you want the info of
|
|
- **robot**, *string*: the object id of the robot you want the info of.
|
|
|
|
|
|
|
|
|
|
### Lock
|
|
### 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
|
|
https://portal.robotsindeklas.nl/API/v1/robot/lock
|
|
```
|
|
```
|
|
|
|
|
|
Parameters:
|
|
Parameters:
|
|
- **robot**, *string*: the object id of the robot you want to lock
|
|
- **robot**, *string*: the object id of the robot you want to lock;
|
|
- **lock**, *boolean*, (optional, default: false): do you want to lock this robot (true)
|
|
- **lock**, *boolean*, (optional, default: false): lock (true) or unlock (false) this robot.
|
|
|
|
|
|
|
|
|
|
### Share
|
|
### 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
|
|
https://portal.robotsindeklas.nl/API/v1/robot/share
|
|
```
|
|
```
|
|
|
|
|
|
Parameters:
|
|
Parameters:
|
|
- **robot**: the object id of the robot you want to share
|
|
- **robot**, *string*: the object id of the robot you want to share;
|
|
- **level**: 0,1,2,3
|
|
- **level**, *int*: the share level we want to assign to the user or group with this request;
|
|
- **oid**: the object id of the user or group we want the share this robot with |
|
- **oid**, *string*: the object id of the user or group we want the share this robot with. |
|
|
|
\ No newline at end of file |