Workspaces API
Version: 1.0
Ensure the existence of all folders in a path
POST
/workspace/orgs/{org_id}/workspaces/{workspace_id}/folders/path/*Ensures that all folders in the specified path exist. If a folder does not exist, it will be created.
Request
Responses
201
Successful Response
Response schema
foldersobject[]
created_atdate-time
created_byUserModel
Optional
emailstring | null
iduuid
namestring | null
deletedboolean
folder_iduuid
namestring
parent_folder_iduuid | null
pathpath
updated_atdate-time
updated_byUserModel
Optional
emailstring | null
iduuid
namestring | null
workspace_iduuid
Example response
{
"folders": [
{
"created_at": "2024-07-29T15:51:28.071Z",
"created_by": {
"email": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string"
},
"deleted": true,
"folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"parent_folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"path": "string",
"updated_at": "2024-07-29T15:51:28.071Z",
"updated_by": {
"email": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string"
},
"workspace_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
}
401
No permission -- see authorization schemes
Response schema
detailstring | null
invalid-paramsobject[] | null
statusinteger
titlestring
typestring
Example response
{
"detail": "string",
"invalid-params": [
{
"name": "string",
"reason": "string"
}
],
"status": 0,
"title": "string",
"type": "string"
}
403
Request forbidden -- authorization will not help
Response schema
detailstring | null
invalid-paramsobject[] | null
statusinteger
titlestring
typestring
Example response
{
"detail": "string",
"invalid-params": [
{
"name": "string",
"reason": "string"
}
],
"status": 0,
"title": "string",
"type": "string"
}
404
Resource not found or user lacks access
Response schema
detailstring | null
invalid-paramsobject[] | null
statusinteger
titlestring
typestring
Example response
{
"detail": "string",
"invalid-params": [
{
"name": "string",
"reason": "string"
}
],
"status": 0,
"title": "string",
"type": "string"
}
405
Specified method is invalid for this resource
Response schema
detailstring | null
invalid-paramsobject[] | null
statusinteger
titlestring
typestring
Example response
{
"detail": "string",
"invalid-params": [
{
"name": "string",
"reason": "string"
}
],
"status": 0,
"title": "string",
"type": "string"
}
410
Resource is gone
Response schema
detailstring | null
invalid-paramsobject[] | null
statusinteger
titlestring
typestring
Example response
{
"detail": "string",
"invalid-params": [
{
"name": "string",
"reason": "string"
}
],
"status": 0,
"title": "string",
"type": "string"
}
422
Unprocessable Content
Response schema
detailstring | null
invalid-paramsobject[] | null
statusinteger
titlestring
typestring
Example response
{
"detail": "string",
"invalid-params": [
{
"name": "string",
"reason": "string"
}
],
"status": 0,
"title": "string",
"type": "string"
}
