Itil Types
/api/helpdesk/itil-types/{itilTypeId}
Manages HelpDesk ITIL ticket types. Access requires either the general configuration permission or the HelpDesk ITIL-definition permission.
POST creates a request-local ITIL type, applies the supplied writable properties, validates it, and persists it with a server-generated identifier. PUT and PATCH use the same validation. DELETE and active=false perform a soft deactivation; inactive types remain addressable. The configured default type cannot be deactivated and must remain available to all users.
DELETE /api/helpdesk/itil-types/{itilTypeId}
Soft-deactivates this ITIL type. The configured default type produces the 409 code "itil_type_default".
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
itilTypeId |
path | string |
yes | ITIL type identifier |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
204 |
— | — | No content. |
Example Request
# Request DELETE /api/helpdesk/itil-types/<itilTypeId> HTTP/1.1 Accept: application/json Authorization: Bearer <access-token> # Response HTTP/1.1 204 No Content
GET /api/helpdesk/itil-types/{itilTypeId}
Manages HelpDesk ITIL ticket types. Access requires either the general configuration permission or the HelpDesk ITIL-definition permission.
POST creates a request-local ITIL type, applies the supplied writable properties, validates it, and persists it with a server-generated identifier. PUT and PATCH use the same validation. DELETE and active=false perform a soft deactivation; inactive types remain addressable. The configured default type cannot be deactivated and must remain available to all users.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
itilTypeId |
path | string |
yes | ITIL type identifier |
fields |
query | string |
no | Comma-separated readable properties to include in the JSON response. |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
200 |
application/json |
ItilTypeRead |
Successful response. |
Example Request
# Request
GET /api/helpdesk/itil-types/<itilTypeId> HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>
# Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": 0,
"name": "string",
"icon": "string",
"internal": true,
"masterType": true
}
PATCH /api/helpdesk/itil-types/{itilTypeId}
Manages HelpDesk ITIL ticket types. Access requires either the general configuration permission or the HelpDesk ITIL-definition permission.
POST creates a request-local ITIL type, applies the supplied writable properties, validates it, and persists it with a server-generated identifier. PUT and PATCH use the same validation. DELETE and active=false perform a soft deactivation; inactive types remain addressable. The configured default type cannot be deactivated and must remain available to all users.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
itilTypeId |
path | string |
yes | ITIL type identifier |
Request Body
| Content Type | Schema | Required | Description |
|---|---|---|---|
application/json |
ItilTypeUpdate |
yes | — |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
200 |
application/json |
ItilTypeRead |
Successful response. |
Example Request
# Request
PATCH /api/helpdesk/itil-types/<itilTypeId> HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>
Content-Type: application/json
{
"name": "string",
"icon": "string",
"masterType": true,
"protectedContent": true,
"autoClose": true
}
# Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": 0,
"name": "string",
"icon": "string",
"internal": true,
"masterType": true
}
PUT /api/helpdesk/itil-types/{itilTypeId}
Manages HelpDesk ITIL ticket types. Access requires either the general configuration permission or the HelpDesk ITIL-definition permission.
POST creates a request-local ITIL type, applies the supplied writable properties, validates it, and persists it with a server-generated identifier. PUT and PATCH use the same validation. DELETE and active=false perform a soft deactivation; inactive types remain addressable. The configured default type cannot be deactivated and must remain available to all users.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
itilTypeId |
path | string |
yes | ITIL type identifier |
Request Body
| Content Type | Schema | Required | Description |
|---|---|---|---|
application/json |
ItilTypeUpdate |
yes | — |
Response
| Status | Content Type | Schema | Description |
|---|---|---|---|
200 |
application/json |
ItilTypeRead |
Successful response. |
Example Request
# Request
PUT /api/helpdesk/itil-types/<itilTypeId> HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>
Content-Type: application/json
{
"name": "string",
"icon": "string",
"masterType": true,
"protectedContent": true,
"autoClose": true
}
# Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": 0,
"name": "string",
"icon": "string",
"internal": true,
"masterType": true
}
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.
ItilTypeRead
| Property | Type | Required | Description |
|---|---|---|---|
id |
integer (int32) |
no |
Stable server-generated ITIL type identifier. Read-only. |
name |
string |
no |
Required user-visible name, trimmed before storage, at most 50 characters and unique ignoring case. |
icon |
string |
no |
Optional relative name of an existing ITIL icon. This property only stores the name; it does not upload or delete an icon file. |
internal |
boolean |
no |
Whether this ITIL type is internal and system-managed. Read-only. |
masterType |
boolean |
no |
Whether this type is a master that may own linked slave tickets. |
protectedContent |
boolean |
no |
Whether users require the protected-content permission to use this type. |
autoClose |
boolean |
no |
Whether closing a master ticket also closes its linked slaves. This option is applied only when "masterType" is true. |
info |
string |
no |
Optional explanatory information of at most 65535 characters. |
messageType |
integer (int32) |
no |
Mail routing after a new incident: 0 sends no mail, 1 sends to the ticket owner, 2 sends to the assigned resource, and 3 sends to the valid address in "messageEmail". Other values are rejected. |
messageEmail |
string |
no |
Recipient address required when "messageType" is 3; it must be a valid single email address. |
restrictedTo |
object |
no |
Complete access restriction map. JSON keys are "group" and "user"; each value is an array of lowercase alphanumeric GUID strings that must resolve to existing accounts or groups, for example {"group":["0123456789abcdefghijklmno"],"user":[]}. On create, omission defaults to the all-users group. The configured default ITIL type must include that group. |
active |
boolean |
no |
Whether this ITIL type is active. Setting this to false soft-deactivates the type and is subject to the same conflict as DELETE. Setting it to true reactivates it. |
defaultType |
boolean |
no |
Whether this ITIL type is the configured ticket default. Read-only. |
ApiError
| Property | Type | Required | Description |
|---|---|---|---|
status |
integer (int32) |
yes | — |
code |
string |
yes | — |
message |
string |
yes | — |
details |
array<object> |
no | — |
ItilTypeUpdate
| Property | Type | Required | Description |
|---|---|---|---|
name |
string |
no |
Required user-visible name, trimmed before storage, at most 50 characters and unique ignoring case. |
icon |
string |
no |
Optional relative name of an existing ITIL icon. This property only stores the name; it does not upload or delete an icon file. |
masterType |
boolean |
no |
Whether this type is a master that may own linked slave tickets. |
protectedContent |
boolean |
no |
Whether users require the protected-content permission to use this type. |
autoClose |
boolean |
no |
Whether closing a master ticket also closes its linked slaves. This option is applied only when "masterType" is true. |
info |
string |
no |
Optional explanatory information of at most 65535 characters. |
messageType |
integer (int32) |
no |
Mail routing after a new incident: 0 sends no mail, 1 sends to the ticket owner, 2 sends to the assigned resource, and 3 sends to the valid address in "messageEmail". Other values are rejected. |
messageEmail |
string |
no |
Recipient address required when "messageType" is 3; it must be a valid single email address. |
restrictedTo |
object |
no |
Complete access restriction map. JSON keys are "group" and "user"; each value is an array of lowercase alphanumeric GUID strings that must resolve to existing accounts or groups, for example {"group":["0123456789abcdefghijklmno"],"user":[]}. On create, omission defaults to the all-users group. The configured default ITIL type must include that group. |
active |
boolean |
no |
Whether this ITIL type is active. Setting this to false soft-deactivates the type and is subject to the same conflict as DELETE. Setting it to true reactivates it. |