... | @@ -72,3 +72,46 @@ Parameters: |
... | @@ -72,3 +72,46 @@ Parameters: |
|
|
|
|
|
## Response
|
|
## Response
|
|
|
|
|
|
|
|
If the request was successful, you will receive the following response:
|
|
|
|
|
|
|
|
Model:
|
|
|
|
|
|
|
|
```
|
|
|
|
{
|
|
|
|
'_id': ObjectId - The id of the folder
|
|
|
|
'data': {
|
|
|
|
'items': Array - the object ids of the items stored inside the folder
|
|
|
|
},
|
|
|
|
'name': String - The name of the folder, visible in the portal
|
|
|
|
'type': String - The type of the folder (describes which items can be stored inside)
|
|
|
|
'info': String - Additional info describing this folder
|
|
|
|
'tags': Array - An array of tags describing this folder
|
|
|
|
'owner': ObjectId - The user id of the user who owns the folder
|
|
|
|
'author': ObjectId - The user id of the user who created the folder
|
|
|
|
'locked': Boolean - Is the folder locked
|
|
|
|
'access': Integer - The access level you have over this folder
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
```
|
|
|
|
{
|
|
|
|
'_id': {
|
|
|
|
'$oid': '6181f4bcfdb83741374238a1'
|
|
|
|
},
|
|
|
|
'data': {
|
|
|
|
'items': [
|
|
|
|
{'$oid': '6001af2696de5e50e546b1ab'}, {'$oid': '600aace6e0121c1f6e8863c1'}
|
|
|
|
]
|
|
|
|
},
|
|
|
|
'name': 'Exercises',
|
|
|
|
'type': 'folderApp',
|
|
|
|
'info': '',
|
|
|
|
'tags': [],
|
|
|
|
'owner': {'$oid': '6ae8672795fdd61d94272358'},
|
|
|
|
'author': {'$oid': '6ae8672795fdd61d94272358'},
|
|
|
|
'locked': False,
|
|
|
|
'access': 2
|
|
|
|
}
|
|
|
|
``` |
|
|
|
\ No newline at end of file |