/api/helpdesk/itil-types/{itilTypeId}/restrictedTo

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.

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.

# Request
GET /api/helpdesk/itil-types/<itilTypeId>/restrictedTo HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>

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

{
    "property": [
        "djggy61nsmmbyuxa45128oefo"
    ]
}

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.

# Request
PUT /api/helpdesk/itil-types/<itilTypeId>/restrictedTo HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>
Content-Type: application/json

{
    "property": [
        "23akvvlq9g8vlcsad0u35qi0w"
    ]
}

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

{
    "property": [
        "bsdx8u9sk859hk0klv6voapus"
    ]
}

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.