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.

App API

Create

Create a new app with the following request:

https://portal.robotsindeklas.nl/API/v1/app/create

Parameters:

  • name: the new name of the app
  • type: presentation, blocklykids, code, calc
  • tags (optional):
  • settings (optional):

Info

Get the document of a particular app with the following request:

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

Parameter:

  • app: the object id of the app you want the info of

Copy

Create a copy of an existing app with the following request:

https://portal.robotsindeklas.nl/API/v1/app/copy

Parameters:

  • app: the object id of the app you want to copy
  • name (optional): the new name of the copied app

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:

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

Parameters:

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

Share

https://portal.robotsindeklas.nl/API/v1/app/share

Parameters:

  • app: the object id of the app you want to share
  • level: 0,1,2,3
  • oid: the object id of the user or group we want the share this app with

Trash

https://portal.robotsindeklas.nl/API/v1/app/trash

Parameters:

  • app: the object id of the app we want to trash
  • del (boolean): delete (true) or restore (false) deleted item

Assign

https://portal.robotsindeklas.nl/API/v1/app/assign

Parameters:

  • app: the object id of the app we want to trash
  • send (array): list of user or group ids we want to share this app with
  • remove (boolean): assign or remove assignment // TODO might rename to assign

Link

https://portal.robotsindeklas.nl/API/v1/app/link

Parameters:

  • app: the object id of the app we want to link
  • send (array): list of robot ids we want to link this app with
  • remove (boolean): link or de-link // TODO might rename to link

Send

https://portal.robotsindeklas.nl/API/v1/app/send

Parameters:

  • app: the object id of the app we want to send
  • send (array): the object id of the user or group we want the send a copy of the app to