Folders
/api/helpdesk/processes/folders/{folderId}/tree
Exposes process folders below /api/helpdesk/processes/folders.
The collection resource returns the protected root node. The root contains compact metadata for its direct processes and one shallow level of FolderSummary children. Clients resolve a child folder to obtain that folder's direct processes and next-level children. This keeps a large folder tree from being repeated in every response; no parentId query parameter is required.
The root has a stable, generated identifier and parentId=null. Every direct child refers to that root identifier in its parentId. Folder names and parent identifiers are the only persisted writable properties; read-only identifiers are accepted and ignored for GET-to-PUT/PATCH round-trips. PATCH updates are staged and persisted by commit; there is no separate move action. A normal DELETE is limited to empty folders. Recursive deletion is an explicit confirmation-protected DELETE action.
DELETE /api/helpdesk/processes/folders/{folderId}/tree
Recursively deletes this folder and all contained processes and descendants.
The operation is protected by an explicit query confirmation, matching the Forms folder contract. Any value other than true is rejected without changing data.
DELETE /api/helpdesk/processes/folders/{folderId}/tree?confirm=true
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
folderId |
path | string |
yes | folder identifier from the URL, including the root identifier |
confirm |
query | boolean |
yes | must be true to authorize recursive deletion |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
204 |
— | — | No content. |
Example Request
# Request DELETE /api/helpdesk/processes/folders/<folderId>/tree?confirm=true HTTP/1.1 Accept: application/json Authorization: Bearer <access-token> # Response HTTP/1.1 204 No Content
Common Error Responses
The status codes 400, 403, 404, 405, 406, 409, 413, 415, and 500 use the same ApiError JSON error format:
{
"status": 404,
"code": "route_not_found",
"message": "The requested API route does not exist.",
"details": []
}
Schemas
Request and response schemas used on this page.
ApiError
| Property | Type | Required | Description |
|---|---|---|---|
status |
integer (int32) |
yes | — |
code |
string |
yes | — |
message |
string |
yes | — |
details |
array<object> |
no | — |