Folder API

This is an old version of this page. You can view the most recent version or browse the history.

Create a new folder for the user that has authenticated itself.

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

Parameters:

name, string: the new name of the folder;
type, string: the type of folder. We currently only support the type folderApp.

Get the document of a particular folder.

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

Parameter:

Create a copy of an existing folder.

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

Parameters:

folder, string: the object id of the folder you want to copy;
name, string, (optional, default: name of the original folder): the new name of the copied folder.

Lock a folder. If a folder is locked, users with play or edit share rights will no longer have access to the content of the apps inside the folder.

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

Parameters:

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

Share a folder 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 folder;
1 (play rights): user or group is only allowed to view and play the contents of this folder;
2 (edit rights): user or group is allowed to play and edit the contents of this folder;
3 (admin rights): user or group is allowed to play, edit and further share the contents of this folder with other users.

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

Parameters:

folder, string: the object id of the folder 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 folder with.

Remove a folder or bring it back from the trash bin.

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

Parameters: