/api/helpdesk/forms/capabilities/schema

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.

Returns the stable Forms dependency rules and examples.

The documentation is separated from capabilities because it is independent of the current installation's ticket fields, actions, statuses, and permissions. Clients may cache this resource and use it together with the compact operational capability response. Rules describe constraints such as OR-of-AND section conditions, APPLY_ACTION allowlists, ticket-attribute dependencies, e-mail dependencies, public-folder restrictions, and the atomic replacement semantics of ordered sections.

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

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

{
    "examples": [
        {
            "payload": "{\"sections\":[{\"fields\":[{\"key\":\"country\",\"fieldType\":\"Standard\",\"fieldDataType\":\"select\"}],\"conditions\":[],\"actions\":[]},{\"fields\":[],\"conditions\":[{\"conditions\":[{\"fieldKey\":\"country\",\"operator\":\"EQUALS\",\"value\":\"{\\\"label\\\":\\\"Germany\\\",\\\"value\\\":\\\"DE\\\"}\"}]}],\"actions\":[]}]",
            "description": "string",
            "id": "string"
        }
    ],
    "rules": [
        {
            "id": "string",
            "semantics": "OR_OF_AND",
            "properties": [
                
            ]
        }
    ]
}

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.

Type: object