Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
P Portal-api
  • Project overview
    • Project overview
    • Details
    • Activity
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Activity
  • Create a new issue
  • Issue Boards
Collapse sidebar
  • doc
  • Portal-api
  • Wiki
  • Folder API

Folder API · Changes

Page history
Added response chapter authored Apr 22, 2022 by Jurjen Brouwer's avatar Jurjen Brouwer
Show whitespace changes
Inline Side-by-side
Showing with 43 additions and 0 deletions
+43 -0
  • Folder-API.md Folder-API.md +43 -0
  • No files found.
Folder-API.md
View page @ c73ee9de
......@@ -72,3 +72,46 @@ Parameters:
## 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
Clone repository
  • App API
  • Folder API
  • Group API
  • Robot API
  • User API
  • Home