/api/helpdesk/forms/export

Exposes HelpDesk Forms archive transfer operations below the forms resource.

GET /api/helpdesk/forms/export exports one form when formId is supplied; otherwise it exports the selected folder as a legacy-compatible bundle. Folder exports default to the root folder and include only direct forms unless includeSubfolders=true is set. POST /api/helpdesk/forms/import accepts one or more .form files or folder bundles in multipart parts, with JSON options in the reserved json part.

Import planning is delegated to FormArchiveService. The service validates every archive before applying changes and supports ConflictPolicy#FAIL, ConflictPolicy#OVERWRITE, and ConflictPolicy#COPY. The framework preview mode and the request's ImportRequest#preview flag both produce a write-free import plan.

Exports one form archive or a folder bundle.

Examples:

 GET /api/helpdesk/forms/export?formId=FORM_ID
 GET /api/helpdesk/forms/export?folderId=FOLDER_ID&includeSubfolders=true
 

When neither identifier is supplied, the root folder is exported. Supplying both identifiers is rejected because one request cannot select both archive shapes.

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

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

string

Hard-deletes this form. A subsequent GET of its identifier returns 404.

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

# Response
HTTP/1.1 204 No Content

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.

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

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

{
    "name": "string",
    "id": "8p0fg252nzach8ru1kp54aidx",
    "activated": true,
    "useFormLogo": true,
    "iconDataUri": "string"
}

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.

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

{
    "name": "string",
    "id": "7qdlfbzs3tfxv53x9migmlq8q",
    "activated": true,
    "useFormLogo": true,
    "iconDataUri": "string"
}

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

{
    "name": "string",
    "id": "8p0fg252nzach8ru1kp54aidx",
    "activated": true,
    "useFormLogo": true,
    "iconDataUri": "string"
}

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.

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

{
    "name": "string",
    "id": "7qdlfbzs3tfxv53x9migmlq8q",
    "activated": true,
    "useFormLogo": true,
    "iconDataUri": "string"
}

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

{
    "name": "string",
    "id": "8p0fg252nzach8ru1kp54aidx",
    "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.