|
|
### Create
|
|
### Create
|
|
|
|
|
Create a new folder for the user that has authenticated itself.
|
|
|
```
|
|
```
|
|
|
https://portal.robotsindeklas.nl/API/v1/folder/create
|
|
https://portal.robotsindeklas.nl/API/v1/folder/create
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
Parameters:
|
|
|
- **name**: the new name of the folder
|
|
- **name**, *string*: the new name of the folder;
|
|
|
- **type**: the type of folder (folderApp, folderUser)
|
|
- **type**, *string*: the type of folder. We currently only support the type `folderApp`.
|
|
|
|
|
|
|
|
### Info
|
|
|
|
|
|
|
|
|
|
|
### Info
|
|
|
|
Get the document of a particular folder.
|
|
|
```
|
|
```
|
|
|
https://portal.robotsindeklas.nl/API/v1/folder/info
|
|
https://portal.robotsindeklas.nl/API/v1/folder/info
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
Parameter:
|
|
Parameter:
|
|
|
- **folder**: the object id of the folder you want the info of
|
|
- **folder**, *string*: the object id of the folder you want the info of
|
|
|
|
|
|
|
|
### Copy
|
|
### Copy
|
|
|
|
|
Create a copy of an existing folder.
|
|
|
```
|
|
```
|
|
|
https://portal.robotsindeklas.nl/API/v1/folder/copy
|
|
https://portal.robotsindeklas.nl/API/v1/folder/copy
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
Parameters:
|
|
|
- **folder**: the object id of the folder you want to copy
|
|
- **folder**, *string*: the object id of the folder you want to copy;
|
|
|
- **name** (optional): the new name of the copied folder
|
|
- **name**, *string*, (optional, default: name of the original folder): the new name of the copied folder.
|
|
|
|
|
|
|
|
|
|
|
|
### Lock
|
|
### Lock
|
|
|
|
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
|
|
https://portal.robotsindeklas.nl/API/v1/folder/lock
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
Parameters:
|
|
|
- **folder**, *string*: the object id of the folder you want to lock
|
|
- **folder**, *string*: the object id of the folder you want to lock;
|
|
|
- **lock**, *boolean*, (optional, default: false): do you want to lock this folder (true)
|
|
- **lock**, *boolean*, (optional, default: false): lock (true) or unlock (false) this folder.
|
|
|
|
|
|
|
|
|
|
|
|
|
### Share
|
|
### Share
|
|
|
|
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
|
|
https://portal.robotsindeklas.nl/API/v1/folder/share
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
Parameters:
|
|
|
- **folder**: the object id of the folder you want to share
|
|
- **folder**, *string*: the object id of the folder you want to share;
|
|
|
- **level**: 0,1,2,3
|
|
- **level**, *int*: the share level we want to assign to the user or group with this request;
|
|
|
- **oid**: the object id of the user or group we want the share this folder with
|
|
- **oid**, *string*: the object id of the user or group we want the share this folder with.
|
|
|
|
|
|
|
|
### Trash
|
|
|
|
|
|
|
|
|
|
|
### Trash
|
|
|
|
Remove a folder or bring it back from the trash bin.
|
|
|
```
|
|
```
|
|
|
https://portal.robotsindeklas.nl/API/v1/folder/trash
|
|
https://portal.robotsindeklas.nl/API/v1/folder/trash
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
Parameters:
|
|
|
- **folder**: the object id of the folder we want to trash
|
|
- **folder**, *string*: the object id of the folder we want to trash;
|
|
|
- **del** (boolean): delete (true) or restore (false) deleted item |
|
- **del**, *boolean*: delete (true) or restore (false) deleted item. |
|
\ No newline at end of file |
|
\ No newline at end of file |
