Chat now with support
Chat with Support

KACE Systems Management Appliance 13.2 Common Documents - API Reference Guide

Managed Install API Reference

Managed Install API Reference

KACE SMA Managed Install API Reference

Overview

Version information

Version : 13.2

URI scheme

BasePath : /api/mi

Consumes

•
application/json

Produces

•
application/json

Paths

GET /api/managed_install/mamaged_installs/{id}/machines

Description

Returns devices targeted by the managed install

Parameters

Type
Name
Description
Schema

Path

id required

Managed Install ID

integer

Query

filtering optional

string

Query

offset optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Responses

HTTP Code
Schema

200

Response 200

Response 200

Name
Schema

Machines optional

< machine > array

GET /api/managed_install/managed_installs

Description

Returns a list of all managed installs.

Parameters

Type
Name
Schema

Query

filtering optional

string

Query

offset optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

< string > array

GET /api/managed_install/managed_installs/{id}

Description

Gets the details of this managed install

Parameters

Type
Name
Schema

Path

id required

integer

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

string

PUT /api/managed_install/managed_installs/{id}/add_to_machines

Description

Adds devices to a managed install.

Parameters

Type
Name
Description
Schema

Path

id required

integer

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Body

machines required

A payload with the machines to update. For example: { "Machines" : ["id"]}

json

Responses

HTTP Code
Schema

200

No Content

GET /api/managed_install/managed_installs/{id}/compatible_machines

Description

Returns a list of compatible devices for this managed install.

Parameters

Type
Name
Schema

Path

id required

integer

Query

filtering optional

string

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

< string > array

GET /api/managed_install/managed_installs/{id}/file

Description

Gets the file associated with this managed install.

Parameters

Type
Name
Schema

Path

id required

integer

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

string

PUT /api/managed_install/managed_installs/{id}/remove_from_machines

Description

Removed devices from a managed install.

Parameters

Type
Name
Description
Schema

Path

id required

integer

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Body

machines required

A payload with the machines to update

json

Responses

HTTP Code
Schema

200

No Content

GET /api/mi/compatible_machines

Description

Returns a list of compatible machines

Parameters

Type
Name
Schema

Query

filtering optional

string

Query

offset optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

< string > array

GET /api/mi/files

Description

Returns the list of files available to managed installs.

Parameters

Type
Name
Schema

Query

filtering optional

string

Responses

HTTP Code
Schema

200

< string > array

Definitions

machine

Name
Schema

id optional

integer

name optional

string

user optional

string

Scripting API Reference

Scripting API Reference

KACE SMA Scripting API Reference

Overview

Version information

Version : 13.2

URI scheme

BasePath : /api/script

Consumes

•
application/json

Produces

•
application/json

Paths

POST /api/script

Description

Creates a new script

Parameters

Type
Name
Schema

Body

scriptDTO required

ScriptShellDTO

Responses

HTTP Code
Schema

200

ScriptShellDTO

GET /api/script/runStatus/{runId}

Description

Get status of progress script

Parameters

Type
Name
Schema

Path

runId required

integer

Responses

HTTP Code
Schema

200

RunStatusDTO

GET /api/script/{scriptId}

Description

Get a specific script

Parameters

Type
Name
Schema

Path

scriptId required

integer

Responses

HTTP Code
Schema

200

ScriptShellDTO

PUT /api/script/{scriptId}

Description

Updates a specific script

Parameters

Type
Name
Schema

Path

scriptId required

integer

Body

scriptDTO required

ScriptShellDTO

Responses

HTTP Code
Schema

200

ScriptShellDTO

DELETE /api/script/{scriptId}

Description

Removes a specific script with all dependencie

Parameters

Type
Name
Schema

Path

scriptId required

integer

Responses

HTTP Code
Schema

200

No Content

POST /api/script/{scriptId}/actions/run

Description

Executes a specific script

Parameters

Type
Name
Description
Schema

Path

scriptId required

integer

Query

machineIDs required

list of machine IDs to run on, or 'all'

integer

Responses

HTTP Code
Schema

200

integer

GET /api/script/{scriptId}/dependencies

Description

Get all dependency of script

Parameters

Type
Name
Schema

Path

scriptId required

integer

Responses

HTTP Code
Schema

200

< DependencyDTO > array

POST /api/script/{scriptId}/dependency/{dependencyName}

Description

Uploads and attaches a new dependency

Parameters

Type
Name
Schema

Path

dependencyName required

string

Path

scriptId required

integer

Body

file required

file

Responses

HTTP Code
Schema

200

DependencyDTO

GET /api/script/{scriptId}/dependency/{dependencyName}

Description

Get a specific dependency of script

Parameters

Type
Name
Schema

Path

dependencyName required

string

Path

scriptId required

integer

Responses

HTTP Code
Schema

200

DependencyDTO

PUT /api/script/{scriptId}/dependency/{dependencyName}

Description

Update a specific dependency

Parameters

Type
Name
Schema

Path

dependencyName required

string

Path

scriptId required

integer

Body

file required

file

Responses

HTTP Code
Schema

200

DependencyDTO

DELETE /api/script/{scriptId}/dependency/{dependencyName}

Description

Removes a specific dependency of script

Parameters

Type
Name
Schema

Path

dependencyName required

string

Path

scriptId required

integer

Responses

HTTP Code
Schema

200

No Content

GET /api/script/{scriptId}/dependency/{dependencyName}/download

Description

Download binary dependency data of script. Allows to download streaming data

Parameters

Type
Name
Schema

Path

dependencyName required

string

Path

scriptId required

integer

Responses

HTTP Code
Schema

200

file

POST /api/script/{scriptId}/task

Description

Creates a new task

Parameters

Type
Name
Schema

Path

scriptId required

integer

Body

taskDTO required

TaskDTO

Responses

HTTP Code
Schema

200

< TaskDTO > array

GET /api/script/{scriptId}/task/{orderId}

Description

Update a specific task

Parameters

Type
Name
Schema

Path

orderId required

integer

Path

scriptId required

integer

Responses

HTTP Code
Schema

200

TaskDTO

PUT /api/script/{scriptId}/task/{orderId}

Description

Update a specific task

Parameters

Type
Name
Schema

Path

orderId required

integer

Path

scriptId required

integer

Body

taskDTO required

TaskDTO

Responses

HTTP Code
Schema

200

< TaskDTO > array

DELETE /api/script/{scriptId}/task/{orderId}

Description

Removes a specific task of script

Parameters

Type
Name
Schema

Path

orderId required

integer

Path

scriptId required

integer

Responses

HTTP Code
Schema

200

< TaskDTO > array

GET /api/script/{scriptId}/tasks

Description

Get all tasks of specific script

Parameters

Type
Name
Schema

Path

scriptId required

integer

Responses

HTTP Code
Schema

200

< TaskDTO > array

GET /api/scripts

Description

Get all founded scripts

Parameters

Type
Name
Description
Schema

Query

compatibleForMachineId optional

machine identificator

string

Query

count optional

the maximum number of rows to return

integer

Query

searchText optional

text to search is the Description and Notes fields of a script

string

Query

sorting optional

comma-separated list to sort results

string

Query

start optional

offset of the first row to return

integer

Query

type optional

public, private or all

string

Responses

HTTP Code
Schema

200

< ScriptShellDTO > array

Definitions

DependencyDTO

Name
Schema

checksum optional

string

fileSize optional

integer(integer)

name optional

string

MachineDTO

Name
Schema

ip optional

string

kbotLogId optional

integer(integer)

machineId optional

integer(integer)

name optional

string

requestStatus optional

string

requestTime optional

string

status optional

integer(integer)

RunStatusDTO

Name
Schema

failed optional

< MachineDTO > array

pending optional

< MachineDTO > array

pushFailed optional

< MachineDTO > array

scriptId optional

integer(integer)

success optional

< MachineDTO > array

targeted optional

< MachineDTO > array

ScriptOfflineDTO

Name
Schema

dependencies optional

< DependencyDTO > array

description optional

string

enabled optional

boolean(boolean)

id optional

integer(integer)

machines optional

< object > array

name optional

string

notes optional

string

osTypes optional

< object > array

schedule optional

< string > array

scheduleType optional

string

status optional

string

tasks optional

< TaskDTO > array

type optional

string

ScriptOnlineDTO

Name
Schema

alertDialogOptions optional

< object > array

alertDialogTimeout optional

integer(integer)

alertDialogTimeoutAction optional

string

alertEnabled optional

boolean(boolean)

alertMessage optional

string

alertSnoozeDuration optional

integer(integer)

dependencies optional

< DependencyDTO > array

description optional

string

enabled optional

boolean(boolean)

id optional

integer(integer)

machines optional

< object > array

name optional

string

notes optional

string

osTypes optional

< object > array

runAs optional

integer(integer)

schedule optional

< string > array

scheduleType optional

string

status optional

string

tasks optional

< TaskDTO > array

type optional

string

ScriptShellDTO

Name
Schema

alertDialogOptions optional

< object > array

alertDialogTimeout optional

integer(integer)

alertDialogTimeoutAction optional

string

alertEnabled optional

boolean(boolean)

alertMessage optional

string

alertSnoozeDuration optional

integer(integer)

dependencies optional

< DependencyDTO > array

description optional

string

enabled optional

boolean(boolean)

fileName optional

string

id optional

integer(integer)

machines optional

< object > array

name optional

string

notes optional

string

osTypes optional

< object > array

removeFiles optional

boolean(boolean)

runAs optional

integer(integer)

schedule optional

< string > array

scheduleType optional

string

scriptText optional

string

status optional

string

tasks optional

< TaskDTO > array

timeout optional

integer(integer)

type optional

string

uploadFile optional

boolean(boolean)

uploadFileName optional

string

uploadFilePath optional

string

TaskDTO

Name
Schema

attempts optional

integer(integer)

onFailure optional

string

onRemediationFailure optional

< TaskStepDTO > array

onRemediationSuccess optional

< TaskStepDTO > array

onVerifyFailure optional

< TaskStepDTO > array

onVerifySuccess optional

< TaskStepDTO > array

ordinalId optional

integer(integer)

verify optional

< TaskStepDTO > array

TaskStepDTO

Name
Schema

id optional

integer(integer)

params optional

object

User API Reference

User API Reference

KACE SMA User API Reference

Overview

Version information

Version : 13.2

URI scheme

BasePath : /api/user

Consumes

•
application/json

Produces

•
application/json

Paths

GET /api/users/me/

Description

Gets additional user information associated with the currently logged in user.

Responses

HTTP Code
Schema

200

UserSessionData

GET /api/users/users/

Description

Retrieves user records.

Parameters

Type
Name
Schema

Query

filtering optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Responses

HTTP Code
Schema

200

Response 200

Response 200

Name
Schema

Users optional

< user > array

GET /api/users/users/{id}

Description

Returns the user associated with the id

Parameters

Type
Name
Schema

Path

id required

integer

Query

shaping optional

string

Responses

HTTP Code
Schema

200

Response 200

Response 200

Name
Schema

Users optional

< user > array

GET /api/users/{id}/permissions/

Description

Gets the list of permissions associated with the user.

Parameters

Type
Name
Schema

Path

id required

integer

Responses

HTTP Code
Schema

200

Permissions

Definitions

Permissions

Name
Schema

canAddTickets optional

boolean

canAddTicketsUserPortal optional

boolean

licensedFeatures optional

< object > array

permissions optional

< object > array

userId optional

integer

UserSessionData

Name
Schema

RESTAPIVersion optional

integer

apiEnabled optional

boolean

canAddTickets optional

boolean

canAddTicketsUserPortal optional

boolean

currentOrgId optional

integer

defaultQueueID optional

integer

licensedFeatures optional

< object > array

localTimezone optional

string

loggedin optional

string

loggedinEmail optional

string

loggedinFullName optional

string

loggedinId optional

integer

multiple_org_ui optional

integer

org_count optional

integer

orgs optional

< object > array

permissions optional

< object > array

serialNumber optional

string

userId optional

integer

user

Name
Schema

api_enabled optional

integer

archived_by optional

integer

budget_code optional

string

device_count optional

integer

domain optional

string

email optional

string

full_name optional

string

hd_default_queue_id optional

integer

hd_default_view optional

string

home_phone optional

string

id optional

integer

is_archived optional

integer

ldap_uid optional

string

level optional

integer

linked_appliance_id optional

integer

locale_browser_id optional

integer

location_id optional

integer

manager_id optional

integer

mobile_phone optional

string

pager_phone optional

string

password optional

string

path optional

string

permissions optional

integer

primary_device_id optional

integer

role_id optional

integer

sales_notifications optional

integer

security_notifications optional

integer

user_name optional

string

work_phone optional

string

Service Desk API Reference

Service Desk API Reference

KACE SMA Service Desk API Examples

KACE SMA Service Desk API Reference

Overview

Version information

Version : 13.2

URI scheme

BasePath : /api/service_desk

Consumes

•
application/json

Produces

•
application/json

Paths

GET /api/service_desk/queues/

Description

Returns a list of all queues

Parameters

Type
Name
Description
Schema
Default

Query

filterOptions optional

The name of join set to insert in base query

string

""

Query

filtering optional

string

Query

offset optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Responses

HTTP Code
Schema

200

Response 200

Response 200

Name
Schema

Queues optional

< hd_queue > array

GET /api/service_desk/queues/{id}

Description

Returns the queue associated with the id

Parameters

Type
Name
Schema

Path

id required

integer

Query

shaping optional

string

Query

sorting optional

string

Responses

HTTP Code
Schema

200

Response 200

Response 200

Name
Schema

Queues optional

< hd_queue > array

GET /api/service_desk/queues/{id}/patterns/{id}

Description

Returns the queue associated with the id

Parameters

Type
Name
Schema

Path

id required

integer

Path

queueID required

integer

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

Response 200

Response 200

Name
Schema

Queues optional

< hd_queue > array

GET /api/service_desk/queues/{id}/ticket_owners

Description

Returns ticket owners for the specified queue

Parameters

Type
Name
Schema

Path

id required

integer

Query

filtering optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Responses

HTTP Code
Schema

200

Response 200

Response 200

Name
Schema

Users optional

< user > array

GET /api/service_desk/queues/{id}/ticket_submitters

Description

Returns ticket submitters for the specified queue

Parameters

Type
Name
Schema

Path

id required

integer

Query

filtering optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Responses

HTTP Code
Schema

200

Response 200

Response 200

Name
Schema

Users optional

< user > array

GET /api/service_desk/queues/{id}/ticket_template

Description

Returns a ticket template for the specified queue, usable for ticket creation

Parameters

Type
Name
Description
Schema
Default

Path

id required

integer

Query

pattern optional

The ID of ticket template to apply

string

""

Query

unpackSelects optional

Return multiselect custom fields as arrays of strings

string

""

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

Response 200

Response 200

Name
Schema

Tickets optional

< hd_ticket > array

GET /api/service_desk/queues/{queueID}/fields

Description

Returns a list of all a queue’s fields

Parameters

Type
Name
Description
Schema
Default

Query

pattern optional

The ID of ticket template to apply

string

""

Query

unpackSelects optional

Return multiselect custom fields as arrays of strings

string

""

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

Response 200

Response 200

Name
Schema

Users optional

< ticket_field > array

GET /api/service_desk/queues/{queueID}/patterns

Description

Returns a list of a queue’s patterns

Parameters

Type
Name
Description
Schema
Default

Path

queueID required

integer

Query

filterOptions optional

Expected usage of list - can be forCreate

string

""

Query

filtering optional

string

Query

offset optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

Response 200

Response 200

Name
Schema

Patterns optional

< hd_ticket_template > array

GET /api/service_desk/settings

Description

Returns queue terminology

Responses

HTTP Code
Schema

200

object

POST /api/service_desk/tickets

Description

Creates a new ticket

Parameters

Type
Name
Schema

Body

ticketData required

ticketData

ticketData

Name
Schema

Tickets optional

< hd_ticket > array

Responses

HTTP Code
Schema

200

string

GET /api/service_desk/tickets

Description

Returns a list of all tickets. Sub-entities that can be used on shaping and filtering directives include owner, submitter, queue, category, priority, status, machine, asset, related_tickets, referring_tickets

Parameters

Type
Name
Description
Schema
Default

Query

filtering optional

Comma-separated list of filter directives

string

Query

paging optional

Paging directive including limit and offset

string

Query

shaping optional

Comma-separated list of shape directives

string

Query

sorting optional

Comma-separated list of sorting directives

string

Query

unpackSelects optional

Return multiselect custom fields as arrays of strings

string

""

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

Response 200

Response 200

Name
Schema

Tickets optional

< hd_ticket > array

POST /api/service_desk/tickets/stats

Description

Performs an arbitrary number of fetch requests

Parameters

Type
Name
Schema

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Body

ticketStatsRequestData required

ticketStatsRequestData

ticketStatsRequestData

Name
Schema

Stats optional

< statistics_request > array

Responses

HTTP Code
Schema

200

Response 200

Response 200

Name
Schema

Stats optional

< statistics_response > array

POST /api/service_desk/tickets/{id}

Description

Updates a ticket

Parameters

Type
Name
Schema

Path

id required

integer

Body

ticketData required

ticketData

ticketData

Name
Schema

Tickets optional

< hd_ticket > array

Responses

HTTP Code
Schema

200

string

GET /api/service_desk/tickets/{id}

Description

Returns the asset associated with the id

Parameters

Type
Name
Description
Schema
Default

Path

id required

integer

Query

applyPattern optional

Applies ticket template associated with ticket if any

string

""

Query

shaping optional

Comma-separated list of shape directives

string

Query

sorting optional

Comma-separated list of sorting directives for subqueries

string

Query

unpackSelects optional

Return multiselect custom fields as arrays of strings

string

""

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

Response 200

Response 200

Name
Schema

Tickets optional

< hd_ticket > array

PUT /api/service_desk/tickets/{id}

Description

Updates a ticket

Parameters

Type
Name
Schema

Path

id required

integer

Body

ticketData required

ticketData

ticketData

Name
Schema

Tickets optional

< hd_ticket > array

Responses

HTTP Code
Schema

200

string

DELETE /api/service_desk/tickets/{id}

Description

Removes a ticket

Parameters

Type
Name
Schema

Path

id required

integer

Responses

HTTP Code
Schema

200

string

POST /api/service_desk/tickets/{id}/approve

Description

Approves a ticket

Parameters

Type
Name
Schema

Body

approvalData required

approvalData

approvalData

Name
Schema

approvalNote optional

string

Responses

HTTP Code
Schema

200

string

POST /api/service_desk/tickets/{id}/clearApproval

Description

Clears approval of a previously approved/rejected ticket

Responses

HTTP Code
Schema

200

string

GET /api/service_desk/tickets/{id}/clone

Description

Returns a ticket template for a cloned ticket

Parameters

Type
Name
Schema

Path

id required

integer

Responses

HTTP Code
Schema

200

Response 200

Response 200

Name
Schema

Tickets optional

< hd_ticket > array

PUT /api/service_desk/tickets/{id}/move_to_queue/{queueID}

Description

Moves a ticket to a different queue

Parameters

Type
Name
Schema

Path

id required

integer

Path

queueID required

integer

Responses

HTTP Code
Schema

200

string

POST /api/service_desk/tickets/{id}/reject

Description

Rejects a ticket

Parameters

Type
Name
Schema

Body

approvalData required

approvalData

approvalData

Name
Schema

approvalNote optional

string

Responses

HTTP Code
Schema

200

string

PUT /api/service_desk/tickets/{id}/switch_pattern/{patternID}

Description

Changes ticket to different pattern

Parameters

Type
Name
Schema

Path

id required

integer

Path

patternID required

integer

Responses

HTTP Code
Schema

200

string

PUT /api/service_desk/tickets/{ticketID}/change/{changeID}

Description

Updates a ticket change. For now only supports adjusting owner only setting.

Parameters

Type
Name
Schema

Path

changeID required

integer

Path

ticketID required

integer

Body

changeData required

changeData

changeData

Name
Schema

Changes optional

< hd_ticket_change > array

Responses

HTTP Code
Schema

200

string

GET /api/service_desk/tickets/{ticketID}/changes

Description

Returns a list of all changes for a ticket

Parameters

Type
Name
Schema

Path

ticketID required

integer

Query

filtering optional

string

Query

offset optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

Response 200

Response 200

Name
Schema

Changes optional

< hd_ticket_change > array

GET /api/service_desk/tickets/{ticketID}/changes/{changeID}/attachments/{attachmentID}

Description

Returns an attachment

Parameters

Type
Name
Schema

Path

attachmentID required

integer

Path

changeID required

integer

Path

ticketID required

integer

Responses

HTTP Code
Schema

200

string(binary)

POST /api/service_desk/tickets/{ticketID}/work

Description

Creates a new ticket work item

Parameters

Type
Name
Schema

Path

ticketID required

integer

Body

workData required

workData

workData

Name
Schema

Work optional

< hd_work > array

Responses

HTTP Code
Schema

200

string

GET /api/service_desk/tickets/{ticketID}/work

Description

Returns a list of all work items for the specified ticket

Parameters

Type
Name
Schema

Path

ticketID required

integer

Query

filtering optional

string

Query

offset optional

string

Query

paging optional

string

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

Response 200

Response 200

Name
Schema

Work optional

< hd_work > array

GET /api/service_desk/tickets/{ticketID}/work/{workID}

Description

Returns the asset associated with the id

Parameters

Type
Name
Schema

Path

ticketID required

integer

Path

workID required

integer

Query

shaping optional

string

Query

sorting optional

string

Query

use_count optional

string

Query

use_count_only optional

string

Query

use_pretty_print optional

boolean

Responses

HTTP Code
Schema

200

Response 200

Response 200

Name
Schema

Work optional

< hd_work > array

DELETE /api/service_desk/tickets/{ticketID}/work/{workID}

Description

Removes a ticket work item

Parameters

Type
Name
Schema

Path

ticketID required

integer

Path

workID required

integer

Responses

HTTP Code
Schema

200

string

Definitions

asset

Name
Schema

asset_class_id optional

integer

asset_data_id optional

integer

asset_status_id optional

integer

asset_type_id optional

integer

id optional

integer

mapped_id optional

integer

name optional

string

owner_id optional

integer

hd_category

Name
Schema

cc_List optional

string

default_owner_id optional

integer

hd_queue_id optional

integer

id optional

integer

name optional

string

ordinal optional

integer

user_settable optional

integer

hd_impact

Name
Schema

id optional

integer

name optional

string

ordinal optional

integer

hd_priority

Name
Schema

color optional

string

escalation_minutes optional

integer

hd_queue_id optional

integer

id optional

integer

is_sla_enabled optional

integer

name optional

string

ordinal optional

integer

resolution_due_date_minutes optional

integer

sla_notification_recurrence_minutes optional

integer

use_business_hours_for_escalation optional

integer

use_business_hours_for_sla optional

integer

hd_queue

Name
Description
Schema

allow_all_approvers optional

integer

allow_all_users optional

integer

allow_delete optional

integer

allow_manager_comment_via_userui optional

integer

allow_owners_edit_all_comment optional

integer

allow_owners_via_adminui optional

integer

allow_parent_close optional

integer

allow_users_edit_own_comment optional

integer

alt_email_addr optional

string

archive_interval optional

string

auto_add_cclist_on_comment optional

integer

categories optional

hd_category data returned when shaping=categories is requested

< hd_category > array

conflict_warning_enabled optional

integer

create_users_on_email optional

integer

default_category_id optional

integer

default_impact_id optional

integer

default_priority_id optional

integer

default_status_id optional

integer

email_user optional

string

id optional

integer

impacts optional

hd_impact data returned when shaping=impacts is requested

< hd_impact > array

name optional

string

owners_only_comments optional

integer

pop_password_enc optional

string

pop_server optional

string

pop_ssl optional

integer

pop_username optional

string

priorities optional

hd_priority data returned when shaping=priorities is requested

< hd_priority > array

purge_interval optional

string

show_new_ticket_attachments optional

integer

show_new_ticket_comments optional

integer

smtp_password_enc optional

string

smtp_port optional

integer

smtp_server optional

string

smtp_username optional

string

statuses optional

hd_status data returned when shaping=statuses is requested

< hd_status > array

hd_status

Name
Schema

id optional

integer

name optional

string

ordinal optional

integer

state optional

string

hd_ticket

Name
Description
Schema

category optional

hd_category data returned when shaping=category is requested

object

cc_list optional

string

custom_1 optional

Might return string or object depending on type of custom field

string

custom_2 optional

Might return string or object depending on type of custom field

string

custom_3 optional

Might return string or object depending on type of custom field

string

custom_4 optional

Might return string or object depending on type of custom field

string

custom_5 optional

Might return string or object depending on type of custom field

string

custom_6 optional

Might return string or object depending on type of custom field

string

custom_7 optional

Might return string or object depending on type of custom field

string

custom_8 optional

Might return string or object depending on type of custom field

string

custom_9 optional

Might return string or object depending on type of custom field

string

hd_queue_id optional

integer

id optional

integer

impact optional

hd_impact data returned when shaping=impact is requested

object

is_manual_due_date optional

integer

owner optional

Owner data returned when shaping=owner is requested

object

priority optional

hd_priority data returned when shaping=priority is requested

object

resolution optional

string

status optional

hd_status data returned when shaping=status is requested

object

submitter optional

Owner data returned when shaping=submitter is requested

object

summary optional

string

title optional

string

hd_ticket_change

Name
Description
Schema

attachments optional

attachment metadata returned when shaping=attachments requested

< ticket_attachment > array

hd_ticket_id optional

integer

id optional

integer

owners_only optional

integer

user optional

user data returned when shaping=user is requested

object

user_id optional

integer

hd_ticket_template

Name
Schema

is_default optional

integer

is_enabled optional

integer

is_process_only optional

integer

limit_template_users optional

integer

queue_id optional

integer

template_name optional

string

hd_work

Name
Description
Schema

hd_ticket_id optional

integer

id optional

integer

note optional

string

user optional

user data returned when shaping=user is requested

object

user_id optional

integer

voided_by optional

integer

machine

Name
Schema

id optional

integer

name optional

string

user optional

string

statistics_request

Name
Schema

filtering optional

string

paging optional

string

shaping optional

string

statistics_response

Name
Schema

filtering optional

string

paging optional

string

result optional

< object > array

shaping optional

string

ticket_attachment

Name
Schema

checksum optional

string

file_name optional

string

file_size optional

integer

hd_ticket_change_id optional

integer

id optional

integer

ticket_field

Name
Schema

column optional

string

jsonKey optional

string

required optional

string

type optional

string

values optional

< string > array

visible optional

string

user

Name
Schema

api_enabled optional

integer

archived_by optional

integer

budget_code optional

string

device_count optional

integer

domain optional

string

email optional

string

full_name optional

string

hd_default_queue_id optional

integer

hd_default_view optional

string

home_phone optional

string

id optional

integer

is_archived optional

integer

ldap_uid optional

string

level optional

integer

linked_appliance_id optional

integer

locale_browser_id optional

integer

location_id optional

integer

manager_id optional

integer

mobile_phone optional

string

pager_phone optional

string

password optional

string

path optional

string

permissions optional

integer

primary_device_id optional

integer

role_id optional

integer

sales_notifications optional

integer

security_notifications optional

integer

user_name optional

string

work_phone optional

string

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating