|
|
|
## Actions
|
|
|
|
|
|
|
### Create
|
|
### Create
|
|
|
Create a new folder for the user that has authenticated itself.
|
|
Create a new folder for the user that has authenticated itself.
|
|
|
```
|
|
```
|
| ... | @@ -5,8 +7,8 @@ https://portal.robotsindeklas.nl/API/v1/folder/create |
... | @@ -5,8 +7,8 @@ https://portal.robotsindeklas.nl/API/v1/folder/create |
|
|
```
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
Parameters:
|
|
|
- **name**, *string*: the new name of the folder;
|
|
- **name** - *string*: the new name of the folder;
|
|
|
- **type**, *string*: the type of folder. We currently only support the type `folderApp`.
|
|
- **type** - *string*: the type of folder. We currently only support the type `folderApp`.
|
|
|
|
|
|
|
|
|
|
|
|
|
### Info
|
|
### Info
|
| ... | @@ -16,7 +18,7 @@ https://portal.robotsindeklas.nl/API/v1/folder/info |
... | @@ -16,7 +18,7 @@ https://portal.robotsindeklas.nl/API/v1/folder/info |
|
|
```
|
|
```
|
|
|
|
|
|
|
|
Parameter:
|
|
Parameter:
|
|
|
- **folder**, *string*: 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.
|
|
Create a copy of an existing folder.
|
| ... | @@ -25,8 +27,8 @@ https://portal.robotsindeklas.nl/API/v1/folder/copy |
... | @@ -25,8 +27,8 @@ https://portal.robotsindeklas.nl/API/v1/folder/copy |
|
|
```
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
Parameters:
|
|
|
- **folder**, *string*: the object id of the folder you want to copy;
|
|
- **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.
|
|
- **name** - *string* - (optional, default: name of the original folder): the new name of the copied folder.
|
|
|
|
|
|
|
|
|
|
|
|
|
### Lock
|
|
### Lock
|
| ... | @@ -37,8 +39,8 @@ https://portal.robotsindeklas.nl/API/v1/folder/lock |
... | @@ -37,8 +39,8 @@ 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): lock (true) or unlock (false) this folder.
|
|
- **lock** - *boolean* - (optional, default: false): lock (true) or unlock (false) this folder.
|
|
|
|
|
|
|
|
|
|
|
|
|
### Share
|
|
### Share
|
| ... | @@ -53,9 +55,9 @@ https://portal.robotsindeklas.nl/API/v1/folder/share |
... | @@ -53,9 +55,9 @@ https://portal.robotsindeklas.nl/API/v1/folder/share |
|
|
```
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
Parameters:
|
|
|
- **folder**, *string*: the object id of the folder you want to share;
|
|
- **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;
|
|
- **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.
|
|
- **oid** - *string*: the object id of the user or group we want the share this folder with.
|
|
|
|
|
|
|
|
|
|
|
|
|
### Trash
|
|
### Trash
|
| ... | @@ -65,5 +67,8 @@ https://portal.robotsindeklas.nl/API/v1/folder/trash |
... | @@ -65,5 +67,8 @@ https://portal.robotsindeklas.nl/API/v1/folder/trash |
|
|
```
|
|
```
|
|
|
|
|
|
|
|
Parameters:
|
|
Parameters:
|
|
|
- **folder**, *string*: 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 |
|
|
|
|
|
## Response
|
|
|
|
|
