|
### Create
|
|
### Create
|
|
Create a new app with the following request:
|
|
Create a new app for the user that has authenticated itself.
|
|
```
|
|
```
|
|
https://portal.robotsindeklas.nl/API/v1/app/create
|
|
https://portal.robotsindeklas.nl/API/v1/app/create
|
|
```
|
|
```
|
... | @@ -11,7 +11,7 @@ Parameters: |
... | @@ -11,7 +11,7 @@ Parameters: |
|
- **settings** (optional):
|
|
- **settings** (optional):
|
|
|
|
|
|
### Info
|
|
### Info
|
|
Get the document of a particular app with the following request:
|
|
Get the document of a particular app.
|
|
```
|
|
```
|
|
https://portal.robotsindeklas.nl/API/v1/app/info
|
|
https://portal.robotsindeklas.nl/API/v1/app/info
|
|
```
|
|
```
|
... | @@ -20,7 +20,7 @@ Parameter: |
... | @@ -20,7 +20,7 @@ Parameter: |
|
- **app**: the object id of the app you want the info of
|
|
- **app**: the object id of the app you want the info of
|
|
|
|
|
|
### Copy
|
|
### Copy
|
|
Create a copy of an existing app with the following request:
|
|
Create a copy of an existing app.
|
|
```
|
|
```
|
|
https://portal.robotsindeklas.nl/API/v1/app/copy
|
|
https://portal.robotsindeklas.nl/API/v1/app/copy
|
|
```
|
|
```
|
... | @@ -30,7 +30,7 @@ Parameters: |
... | @@ -30,7 +30,7 @@ Parameters: |
|
- **name** (optional): the new name of the copied app
|
|
- **name** (optional): the new name of the copied app
|
|
|
|
|
|
### Lock
|
|
### Lock
|
|
Lock an app. If an app is locked, users with play or edit rights will no longer have access to the content of the app. You can lock or unlock an app with the following request:
|
|
Lock an app. If an app is locked, users with play or edit rights will no longer have access to the content of the app.
|
|
```
|
|
```
|
|
https://portal.robotsindeklas.nl/API/v1/app/lock
|
|
https://portal.robotsindeklas.nl/API/v1/app/lock
|
|
```
|
|
```
|
... | @@ -40,6 +40,12 @@ Parameters: |
... | @@ -40,6 +40,12 @@ Parameters: |
|
- **lock**, *boolean*, (optional, default: false): lock (true) or unlock (false) this app
|
|
- **lock**, *boolean*, (optional, default: false): lock (true) or unlock (false) this app
|
|
|
|
|
|
### Share
|
|
### Share
|
|
|
|
Share an app 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 app
|
|
|
|
- 1 (play rights): user or group will be able to only play this app, but not edit it or share it further with other users.
|
|
|
|
- 2 (edit rights): user or group will be able to play and edit this app, but won't be able to share it further with other users.
|
|
|
|
- 3 (admin rights): user or group will be able to play, edit and share this app with other users.
|
|
|
|
|
|
```
|
|
```
|
|
https://portal.robotsindeklas.nl/API/v1/app/share
|
|
https://portal.robotsindeklas.nl/API/v1/app/share
|
... | @@ -52,7 +58,7 @@ Parameters: |
... | @@ -52,7 +58,7 @@ Parameters: |
|
|
|
|
|
|
|
|
|
### Trash
|
|
### Trash
|
|
|
|
Remove an app or bring it back from the trash bin.
|
|
```
|
|
```
|
|
https://portal.robotsindeklas.nl/API/v1/app/trash
|
|
https://portal.robotsindeklas.nl/API/v1/app/trash
|
|
```
|
|
```
|
... | @@ -61,35 +67,34 @@ Parameters: |
... | @@ -61,35 +67,34 @@ Parameters: |
|
- **app**: the object id of the app we want to trash
|
|
- **app**: the object id of the app we want to trash
|
|
- **del** (boolean): delete (true) or restore (false) deleted item
|
|
- **del** (boolean): delete (true) or restore (false) deleted item
|
|
|
|
|
|
### Assign
|
|
### Send
|
|
|
|
Send a copy of an app to another user.
|
|
|
|
```
|
|
|
|
https://portal.robotsindeklas.nl/API/v1/app/send
|
|
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
- **app**: the object id of the app we want to send
|
|
|
|
- **send** (array<string>): the object id of the user or group we want the send a copy of the app to
|
|
|
|
|
|
|
|
### Assign
|
|
|
|
Assign a basic (basis) program to a set of users or groups. When assigning a basic program, the users receiving the app will be able to make the assignment but not see the answer.
|
|
```
|
|
```
|
|
https://portal.robotsindeklas.nl/API/v1/app/assign
|
|
https://portal.robotsindeklas.nl/API/v1/app/assign
|
|
```
|
|
```
|
|
|
|
|
|
Parameters:
|
|
Parameters:
|
|
- **app**: the object id of the app we want to trash
|
|
- **app**: the object id of the app we want to trash
|
|
- **send** (array<string>): list of user or group ids we want to share this app with
|
|
- **oid** (string): the id of a user or group we want to share this app with
|
|
- **remove** (boolean): assign or remove assignment // TODO might rename to assign
|
|
- **assign** (boolean): assign or remove assignment
|
|
|
|
|
|
### Link
|
|
### Link
|
|
|
|
Link an agenda to a robot.
|
|
```
|
|
```
|
|
https://portal.robotsindeklas.nl/API/v1/app/link
|
|
https://portal.robotsindeklas.nl/API/v1/app/link
|
|
```
|
|
```
|
|
|
|
|
|
Parameters:
|
|
Parameters:
|
|
- **app**: the object id of the app we want to link
|
|
- **app**: the object id of the app we want to link
|
|
- **send** (array<string>): list of robot ids we want to link this app with
|
|
- **send** (array<string>): list of robot ids we want to link this app with // TODO why list?
|
|
- **remove** (boolean): link or de-link // TODO might rename to link
|
|
- **link** (boolean): link (true) or de-link (false) |
|
|
|
\ No newline at end of file |
|
|
|
|
|
### Send
|
|
|
|
|
|
|
|
```
|
|
|
|
https://portal.robotsindeklas.nl/API/v1/app/send
|
|
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
- **app**: the object id of the app we want to send
|
|
|
|
- **send** (array<string>): the object id of the user or group we want the send a copy of the app to |
|
|
|
\ No newline at end of file |
|
|