/api/helpdesk/forms

Exposes HelpDesk form definitions through the annotation-based WebAPI.

The endpoint stages changes in request-local state. WebAPICore invokes commit once after applying supplied setters, so PATCH requests preserve properties omitted by clients. Ticket-field, action, and status details are not copied into this endpoint; clients resolve them through the canonical HelpDesk settings resources returned by capabilities.

Sections replace as an ordered collection. Conditions are OR-connected blocks, with conditions inside one block connected by AND. Select defaults and condition values must remain JSON encoded select-option strings, for example {"label":"Other","value":"Other"}.

Form DELETE is a hard delete. After a successful DELETE the form identifier is no longer resolvable and a subsequent GET returns 404; deletion does not create an inactive form.

Lists a bounded page of compact form summaries visible to the configuration administrator.

Pagination is part of the primary collection contract. Omitted values use start zero and a limit of 50; clients can follow pages while hasMore is true.

# Request
GET /api/helpdesk/forms HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>

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

{
    "start": 0,
    "limit": 0,
    "hasMore": true,
    "totalCount": 0,
    "items": [
        {
            "showOnStartPage": true,
            "submitType": "CREATE_TICKET",
            "parentFolderId": "cswoqum7d76hst686y9fugkpx",
            "hasIcon": true,
            "name": "string"
        }
    ]
}

Creates a staged form with a generated identifier in the root folder.

# Request
POST /api/helpdesk/forms HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>
Content-Type: application/json

{
    "name": "string",
    "id": "2z6ey3lx9oz3spd9wlozxm9st",
    "activated": true,
    "useFormLogo": true,
    "iconDataUri": "string"
}

# Response
HTTP/1.1 201 Created
Content-Type: application/json

{
    "name": "string",
    "id": "2m7frlq981msarhu80l5j834d",
    "activated": true,
    "useFormLogo": true,
    "iconDataUri": "string"
}

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": []
}

Request and response schemas used on this page.