{{sidenavigation.sidenavigationExpandLabel}}
{{getMsg('Help_YouAreHere')}}: /  {{page.title}} {{page.title}}
{{$root.getMsg("downLoadHelpAsPdf")}} {{helpModel.downloadHelpPdfDataStatus}}

Folders

/api/helpdesk/processes/folders/{folderId}/id

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.

GET /api/helpdesk/processes/folders/{folderId}/id

Stable folder identifier, including the generated identifier of the root.

Parameters

Name Location Type Required Description
folderId path string yes folder identifier from the URL, including the root identifier

Response

Status Content Type Schema Description
200 application/json string Successful response.

Example Request

# Request
GET /api/helpdesk/processes/folders/<folderId>/id HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>

# Response
HTTP/1.1 200 OK
Content-Type: application/json

"8ctdx9bu0i7sm9q9uw1kt0xar"

PUT /api/helpdesk/processes/folders/{folderId}/id

Accepts the identifier emitted by a GET response for an unchanged PUT/PATCH round-trip. The URL-selected folder remains authoritative.

Parameters

Name Location Type Required Description
folderId path string yes folder identifier from the URL, including the root identifier

Request Body

Content Type Schema Required Description
application/json string yes identifier from a previous GET response

Response

Status Content Type Schema Description
200 application/json string Successful response.

Example Request

# Request
PUT /api/helpdesk/processes/folders/<folderId>/id HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>
Content-Type: application/json

"0rwx08ncykhhik37n7msgmfdr"

# Response
HTTP/1.1 200 OK
Content-Type: application/json

"bohz92m45fma5o2oh27ue21c3"

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 —
i-net HelpDesk
This application uses cookies to allow login. By continuing to use this application, you agree to the use of cookies.


Help