{{getMsg('Help_YouAreHere')}}:
/
{{page.title}}
{{page.title}}
{{$root.getMsg("downLoadHelpAsPdf")}}
{{helpModel.downloadHelpPdfDataStatus}}
Ticket Fields
/api/helpdesk/ticket-fields/{fieldKey}/ratingMaximum
Exposes registered, open, and user-created HelpDesk ticket-field settings.
The endpoint is intentionally request-local: annotation setters only change this object, while commit reconstructs a complete manager property map and delegates validation and persistence to TicketFieldSettingsManager. A normal DELETE operation is not exposed. Hiding a field is represented by FIELD_VISIBILITY#HIDDEN; permanent deletion is available only through the confirmation-protected action.
GET /api/helpdesk/ticket-fields/{fieldKey}/ratingMaximum
Maximum supported rating value. The manager currently fixes this at ten.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
fieldKey |
path | string |
yes | field key |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
200 |
application/json |
integer (int32) |
Successful response. |
Example Request
# Request GET /api/helpdesk/ticket-fields/<fieldKey>/ratingMaximum HTTP/1.1 Accept: application/json Authorization: Bearer <access-token> # Response HTTP/1.1 200 OK Content-Type: application/json 0
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 | — |