Actions
/api/helpdesk/actions/{actionId}/statusId
Manages custom HelpDesk ticket actions. Reading and writing requires the general configuration permission.
POST creates a request-local action, applies the supplied writable properties, validates it, and persists it with a server-generated identifier. PUT and PATCH use the same validation. Internal or inactive actions cannot be changed.
Action deletion and deactivation require restart-sensitive cleanup and are intentionally not exposed by this API. Consequently "active" is read-only and no DELETE operation exists.
GET /api/helpdesk/actions/{actionId}/statusId
Identifier of the active status produced when this action is executed.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
actionId |
path | string |
yes | action identifier |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
200 |
application/json |
integer (int32) |
Successful response. |
Example Request
# Request GET /api/helpdesk/actions/<actionId>/statusId HTTP/1.1 Accept: application/json Authorization: Bearer <access-token> # Response HTTP/1.1 200 OK Content-Type: application/json 0
PUT /api/helpdesk/actions/{actionId}/statusId
Identifier of the active status produced when this action is executed.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
actionId |
path | string |
yes | action identifier |
Request Body
| Content Type | Schema | Required | Description |
|---|---|---|---|
application/json |
integer (int32) |
yes |
Identifier of the active status produced when this action is executed. |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
200 |
application/json |
integer (int32) |
Successful response. |
Example Request
# Request PUT /api/helpdesk/actions/<actionId>/statusId HTTP/1.1 Accept: application/json Authorization: Bearer <access-token> Content-Type: application/json 0 # 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 | — |