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
  • App API

App API · Changes

Page history
Update App API authored Apr 15, 2022 by Jurjen Brouwer's avatar Jurjen Brouwer
Hide whitespace changes
Inline Side-by-side
Showing with 18 additions and 18 deletions
+18 -18
  • App-API.md App-API.md +18 -18
  • No files found.
App-API.md
View page @ 4883668b
...@@ -5,8 +5,8 @@ https://portal.robotsindeklas.nl/API/v1/app/create ...@@ -5,8 +5,8 @@ https://portal.robotsindeklas.nl/API/v1/app/create
``` ```
Parameters: Parameters:
- **name**: the new name of the app - **name**, *string*: the new name of the app
- **type**: presentation, blocklykids, code, calc - **type**, *string*: presentation, blocklykids, code, calc
- **tags** (optional): - **tags** (optional):
- **settings** (optional): - **settings** (optional):
...@@ -17,7 +17,7 @@ https://portal.robotsindeklas.nl/API/v1/app/info ...@@ -17,7 +17,7 @@ https://portal.robotsindeklas.nl/API/v1/app/info
``` ```
Parameter: Parameter:
- **app**: the object id of the app you want the info of - **app**, *string*: the object id of the app you want the info of
### Copy ### Copy
Create a copy of an existing app. Create a copy of an existing app.
...@@ -26,8 +26,8 @@ https://portal.robotsindeklas.nl/API/v1/app/copy ...@@ -26,8 +26,8 @@ https://portal.robotsindeklas.nl/API/v1/app/copy
``` ```
Parameters: Parameters:
- **app**: the object id of the app you want to copy - **app**, *string*: the object id of the app you want to copy
- **name** (optional): the new name of the copied app - **name**, *string*, (optional, default: name of the original app): 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. 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.
...@@ -52,9 +52,9 @@ https://portal.robotsindeklas.nl/API/v1/app/share ...@@ -52,9 +52,9 @@ https://portal.robotsindeklas.nl/API/v1/app/share
``` ```
Parameters: Parameters:
- **app**: the object id of the app you want to share - **app**, *string*: the object id of the app you want to share
- **level**: 0,1,2,3 - **level**, *int*: 0,1,2,3
- **oid**: the object id of the user or group we want the share this app with - **oid**, *string*: the object id of the user or group we want the share this app with
### Trash ### Trash
...@@ -64,8 +64,8 @@ https://portal.robotsindeklas.nl/API/v1/app/trash ...@@ -64,8 +64,8 @@ https://portal.robotsindeklas.nl/API/v1/app/trash
``` ```
Parameters: Parameters:
- **app**: the object id of the app we want to trash - **app**, *string*: 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
### Send ### Send
Send a copy of an app to another user. Send a copy of an app to another user.
...@@ -74,8 +74,8 @@ https://portal.robotsindeklas.nl/API/v1/app/send ...@@ -74,8 +74,8 @@ https://portal.robotsindeklas.nl/API/v1/app/send
``` ```
Parameters: Parameters:
- **app**: the object id of the app we want to send - **app**, *string*: 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 - **send**, *array\<string\>*: the object id of the user or group we want the send a copy of the app to
### Assign ### 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. 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.
...@@ -84,9 +84,9 @@ https://portal.robotsindeklas.nl/API/v1/app/assign ...@@ -84,9 +84,9 @@ https://portal.robotsindeklas.nl/API/v1/app/assign
``` ```
Parameters: Parameters:
- **app**: the object id of the app we want to trash - **app**, *string*: the object id of the app we want to trash
- **oid** (string): the id of a user or group we want to share this app with - **oid**, *string*: the id of a user or group we want to share this app with
- **assign** (boolean): assign or remove assignment - **assign**, *boolean*: assign or remove assignment
### Link ### Link
Link an agenda to a robot. Link an agenda to a robot.
...@@ -95,6 +95,6 @@ https://portal.robotsindeklas.nl/API/v1/app/link ...@@ -95,6 +95,6 @@ https://portal.robotsindeklas.nl/API/v1/app/link
``` ```
Parameters: Parameters:
- **app**: the object id of the app we want to link - **app**, *string*: the object id of the app we want to link
- **send** (array<string>): list of robot ids we want to link this app with // TODO why list? - **send**, *array\<string\>*: list of robot ids we want to link this app with // TODO why list?
- **link** (boolean): link (true) or de-link (false) - **link**, *boolean*: link (true) or de-link (false)
\ No newline at end of file \ No newline at end of file
Clone repository
  • App API
  • Folder API
  • Group API
  • Robot API
  • User API
  • Home