Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
P Portal-api
  • Project overview
    • Project overview
    • Details
    • Activity
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Activity
  • Create a new issue
  • Issue Boards
Collapse sidebar
  • doc
  • Portal-api
  • Wiki
  • Robot API

Robot API · Changes

Page history
Update Robot API authored Apr 15, 2022 by Jurjen Brouwer's avatar Jurjen Brouwer
Show whitespace changes
Inline Side-by-side
Showing with 14 additions and 8 deletions
+14 -8
  • Robot-API.md Robot-API.md +14 -8
  • No files found.
Robot-API.md
View page @ a26f9e4f
### Info
Get the document of a particular robot.
```
https://portal.robotsindeklas.nl/API/v1/robot/info
```
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 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): do you want to lock this robot (true)
- **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**: the object id of the robot you want to share
- **level**: 0,1,2,3
- **oid**: the object id of the user or group we want the share this robot with
- **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.
\ No newline at end of file
Clone repository
  • App API
  • Folder API
  • Group API
  • Robot API
  • User API
  • Home