HelpDesk Forms
/api/helpdesk/forms/{formId}/sections
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 ordered sections, including fields, conditions, and submit actions.
| Name |
Location |
Type |
Required |
Description |
formId |
path |
string |
yes |
form identifier from the URL |
| Status |
Content Type |
Schema |
Description |
200 |
application/json |
array<FormSectionDefinition> |
immutable ordered section list |
# Request
GET /api/helpdesk/forms/<formId>/sections HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>
# Response
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"label": "string",
"title": "string",
"fields": [
],
"conditions": [
],
"actions": [
]
}
]
Replaces the complete ordered section collection.
| Name |
Location |
Type |
Required |
Description |
formId |
path |
string |
yes |
form identifier from the URL |
Request Body
| Content Type |
Schema |
Required |
Description |
application/json |
array<FormSectionDefinition> |
yes |
ordered sections; conditions use OR-of-AND semantics |
| Status |
Content Type |
Schema |
Description |
200 |
application/json |
array<FormSectionDefinition> |
Successful response. |
# Request
PUT /api/helpdesk/forms/<formId>/sections HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>
Content-Type: application/json
[
{
"label": "string",
"title": "string",
"fields": [
],
"conditions": [
],
"actions": [
]
}
]
# Response
HTTP/1.1 200 OK
Content-Type: application/json
[
{
"label": "string",
"title": "string",
"fields": [
],
"conditions": [
],
"actions": [
]
}
]
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.
| Property |
Type |
Required |
Description |
visibility |
string [Normal, ReadOnly, Hidden] |
no |
— |
defaultValue |
string |
no |
— |
selectOptions |
array<string> |
no |
— |
values |
object |
no |
— |
imageDataUri |
string |
no |
— |
label |
string |
no |
— |
selectFilter |
string |
no |
— |
mandatory |
boolean |
no |
— |
labelSetting |
string [SHOW, HIDE, KEEP_SPACE] |
no |
— |
customDefaultValue |
boolean |
no |
— |
placeholder |
string |
no |
— |
fieldType |
string [Ticket, TicketAttribute, Standard, Email, Ui] |
no |
— |
key |
string |
no |
— |
fieldDataType |
string |
no |
— |
includeLabelInInquiry |
boolean |
no |
— |
applyToTicketText |
boolean |
no |
— |
| Property |
Type |
Required |
Description |
fieldKey |
string |
no |
— |
forTicketValue |
boolean |
no |
— |
value |
string |
no |
— |
operator |
string [EQUALS, EQUALS_NOT, EQUALS_IGNORECASE, IS_OR_IS_BELOW, CONTAINS, CONTAINS_NOT, ENDSWITH, STARTSWITH, IS_NOT_EMPTY, GREATER_OR_EQUAL, GREATER_THAN, LESS_OR_EQUAL, LESS_THAN] |
no |
— |
| Property |
Type |
Required |
Description |
actionId |
integer (int32) |
no |
— |
type |
integer (int32) |
no |
— |
afterExecutionText |
string |
no |
— |
ApiError
| Property |
Type |
Required |
Description |
status |
integer (int32) |
yes |
— |
code |
string |
yes |
— |
message |
string |
yes |
— |
details |
array<object> |
no |
— |