KACE Systems Management Appliance 14.1 Common Documents

Chat now with support

KACE SMA Service Desk API Examples

This section provides examples for adding attachments to Service Desk tickets using the KACE SMA API.

Upload an attachment as a ticket change:

Start by executing a multipart/form-data request on the ticket. In the Tickets section the array of one ticket object with the ticket updates includes the change group that has the requirements for the ticket change. The attachmentSet field inside the change group declares what parts to pull in as attachments for the ticket. The brackets in the name of the attachment part ("INVENTORY_FILE[]") allow you us to have multiple parts with the same name, so you can embed up to five attachments in one ticket change.

Determine what attachments are available with a ticket:

GET /api/service_desk/tickets/{ticket ID}/changes?shaping=attachments limited

Retrieve an attachment:

To retrieve an attachment, you must provide the ticket ID, change ID, and attachment ID. These values can be obtained using the above example, Determine what attachments are available with a ticket:.

GET /api/service_desk/tickets/{ticket ID}/changes/{change ID}/attachments/{attachment ID}

Type	Name	Schema
Body	notificationData required	notificationData

notificationData

Name	Schema
NotificationIDs optional	< integer > array

Responses

HTTP Code	Schema
200	string

Type	Name	Schema
Body	notificationData required	notificationData

notificationData

Name	Schema
NotificationIDs optional	< integer > array

Responses

HTTP Code	Schema
200	string

HTTP Code	Schema
200	Response 200

Response 200

Name	Schema
UserNotifications optional	< user_notification > array

Definitions

user_notification

Name	Schema
body optional	string
new optional	integer
notification_id optional	string
notification_type optional	string
time_started optional	integer
timestamp optional	integer
title optional	string