SysAid REST API Details

SysAid Developers is live! 🚀

We've listened to your feedback and are excited to announce the official launch of the SysAid Developers site!

Get full access to our modern API experience and start building today with:

• User API

• Service Record API

• Group APIs

💡 Why switch?

Unlike these static articles, the new Developers site is fully interactive, meaning you can:

• Run API calls directly in the browser

• Explore live, working examples

• Access new capabilities like creating and updating users via API

• Enjoy a significantly smoother, faster integration experience

🔗 Go to SysAid Developers

Login

Parameters

Returns
An access key, the SysAid version, and the basic information of the logged-in user.

Sample JSON return value

{
“language”:”en”,
“sysaid_version”:””,
   “date_format”:”yyyymmdd hh:MM:ss”
   “user”: {
         “id”:”2”,
                  “name”:”ILIENT\Barby”,
                  “info”: [{“key”:”display_name”,”value”:”Barbara Straisend”},
                             {“key”:”email_address”, “value”:”barbara@gmail.com”},
                             {“key”:”building”, “value”:”1C”}]
              }
}

Return values definition

Users

Get Users List

Get a list of users in SysAid.

Parameters

Returns
A list of users. For each user, returns the user ID, user Name, and information as defined in the view and/or fields parameters. If none of them exist, return full user information.

Sample JSON return value

[
    {
“id”:”1”,
       “name”:”ILIENT\Johnny”,
       “info”: [{“key”:”display_name”,”value”:”John Doe”},
                  {“key”:”email_address”, “value”:”john@gmail.com”},
                  {“key”:”building”, “value”:”1A”}]
   },
   {
“id”:”2”,
       “name”:”ILIENT\Barby”,
       “info”: [{“key”:”display_name”,”value”:”Barbara Straisend”},
                  {“key”:”email_address”, “value”:”barbara@gmail.com”},
                  {“key”:”building”, “value”:”1C”}]
   }
]

Return values definition

Get User

Get information on the specified user

Parameters

Returns
The user ID, user Name, and information as defined in the view and/or fields parameters. If none of them exist, return full user information.

Sample JSON return value for /users/1?view=Mobile

 {
  “id”:”1”,
   “name”:”ILIENT\Moshiko”,
   “info”: [{“key”:”display_name”,”value”:”Moshe Cohen”},
               {“key”:”first_name”,”value”:”Moshe”},
               {“key”:”last_name”,”value”:”Cohen”},
               {“key”:”phone”,”value”:”+972.3.6711554”},
               {“key”:”cell_phone”,”value”:”+972.54.5453525”},
               {“key”:”email_address”, “value”:”moshe@gmail.com”},
               {“key”:”cubic”, “value”:”38”}]
   }

Return values definition

Search Users

Get a list of users in SysAid, according to a search criteria.

Parameters

Returns
A list of users that matched the search criteria. For each user, returns the user ID, user Name, isAdmin, isSysAidAdmin, isManager, and information as defined in the view and/or fields parameters. If none of them exist, return full user info.

Sample JSON return value for /users/search?query=Jo&fields=display_name,email_address&limit=2

 [
{ “id”:”1”,
“name”:”ILIENT\Johnny”,
“isAdmin”: true,
“isSysAidAdmin”: false,
“isManager”: true,
“info”: [
{“key”:”display_name”,”keyCaption”:”Name”,
”value”:”John Doe”, ”valueCaption”:”John Doe”},
{“key”:”email_address”, ,”keyCaption”:”Email Address”,
“value”:”john@gmail.com”,
“valueCaption”:”john@gmail.com”},
{“key”:”building”,”keyCaption”:”Building”,
“value”:”1B”, ”valueCaption”:”1B”}]
},
{
“id”:”2”,
“name”:”ILIENT\Barby”,
“isAdmin”: true,
“isSysAidAdmin”: false,
“isManager”: true,
“info”: [
{“key”:”display_name”,”keyCaption”:”Name”,
”value”:”Barbara Straisend”, ”valueCaption”:”Barbara Straisend”},
{“key”:”email_address”, ,”keyCaption”:”Email Address”,
“value”:”barbara@gmail.com”, “valueCaption”:”barbara@gmail.com”},
{“key”:”building”,”keyCaption”:”Building”,
“value”:”1C”, ”valueCaption”:”1C”}]
}
]

Return values definition

Upload user's photo

Uploads the specified user’s photo.

Payload:

Multiple data, including the file.

Parameters

Get User Permissions

Get user permissions

Parameters

None

Returns
User’s full permissions set.

Sample JSON return value or /users/1/permission

{
    “id”:”1”,
    “name”:”ILIENT\Moshiko”,
    “permissions”: [{“key”:”userPermissionUserSelfService”,”value”:”false”},
                        {“key”:”userPermissionHelpDeskView”,“value”:”true”},
                        {“key”:”userPermissionHelpDeskChangeType”,“value”:”All”},
                        {“key”:”userPermissionCMDBViewType”,“value”:”All”},
                        {“key”:”userPermissionInventoryViewGroup”,“value”:”\”},
                         ….]
}

Return values definition

Get a User's Permission

Check a specific user's permission.

Parameters

None

Returns
User’s permission for the requested permission ID.

Sample JSON return value for /users/1/permission/userPermissionUserSelfService

 {“key”:”userPermissionUserSelfService”,”value”:”false”}

Return values definition

Filters

Get Filters List

Get a list of available filters and their values.

Parameters

Returns
A list of all filters. For each filter, returns the fields requested in the fields parameter. If not specified, returns full filter information.

Sample JSON return value for /filters?p=SysAidMobile

[
  {
“id”:”status”,
“type”:”list”,
       “values”:[{“id”:”1”, “caption”:”closed”},
                    {“id”:”2”,“caption”:”awaiting”},
                    {“id”:”3”,“caption”:”reopened”}],
       “metadata”: {”limit”:”20”, “offset”:”0”,”total”:”3”}
  },
  {
“id”:”Priority”,
“type”:”list”,
       “values”:[{“id”:”1”, “caption”:”High”},
                    {“id”:”2”,“caption”:”Urgent”}],
       “metadata”: {”limit”:”20”, “offset”:”0”,”total”:”2”}
  },
  ...
]

Return values definition

Get Filter

Returns the information & available values for the specified filter.

Parameters

Returns
The filter information, according to the requested view.

Sample JSON return value for /filters/status?view=SysAidMobile

{
  “id”:”status”,
  “type”:”list”,
  “values”: [
    {“id”:”1”,“caption”:”Closed”},
    {“id”:”2”,“caption”:”Awaiting”}
    ],
 “metadata”: {”limit”:”20”, “offset”:”0”,”total”:”2”}
}

Return values definition

Service Requests

Get Service Request List

Returns a list of available service records (SRs). Number of SRs to return can be controlled by the Offset, Limit, and Type parameters. Returned SRs can be filtered by the available filters. Each service record includes the fields according to the View and Fields parameters. If none are specified, all SR fields are returned.

Parameters

Returns
A list of service records. For each SR, it returns the SR ID, user permissions to update/delete/archive the SR, and information fields as defined in the view and/or fields parameters. If none of them exist, returns full user information.

Sample JSON return value for /sr?view=SysAidMobile&fields=type,computer_id&limit=2

[
{
 “id”:”5433”,
 “canUpdate”:”true”,
 “canDelete”:”false”,
 “canArchive”:”false’,
 “info”: [
   {“key”:”title”,”keyCaption”:”Title”,”value”:”basic Service Request”,
                                                 ”valueCaption”:”basic Service Request”},
   {“key”:”insert_time”,”keyCaption”:”Request Time”,“value”:”13975648000”,   
                                                      valueCaption”:”2014-04-01 11:46:48”},
   {“key”:”request_user”,”keyCaption”:”Request User”,  
                    “value”:”leo@law.com”,”valueCaption”:”Leonardo Gonzales”},
   {“key”:”description”,”keyCaption”:”Description”, “value”:”Prezados Amos”,  
                                                         “valueCaption”:”Prezados Amos”},
  {“key”:”type,”keyCaption”:”Service Record Type”, “value”:”1”,
                                                        “valueCaption”:”Service Request”},
    {“key”:”computer_id”,”keyCaption”:”Asset ID”,“value”:”none”,
                                                                      “valueCaption”:”none”}]
},
{
  “id”:”5669”,
  “canUpdate”:”true”,
  “canDelete”:”false”,
  “canArchive”:”false’,
  “info”: [
   {“key”:”title”,”keyCaption”:”Title”,”value”:”Relatório de ocorrência”,
                                               ”valueCaption”:”Relatório de ocorrência”},
   {“key”:”insert_time”,”keyCaption”:”Request Time”,“value”:”1392026000”,   
                                                     valueCaption”:”2013-05-28 11:12:50”},
   {“key”:”request_user”,”keyCaption”:”Request User”,  
                    “value”:”leo@law.com”,”valueCaption”:”Leonardo Gonzales”},
   {“key”:”description”,”keyCaption”:”Description”, “value”:”Relatório de
                              ocorrência”,“valueCaption”:”Relatório de ocorrência”},
   {“key”:”type,”keyCaption”:”Service Record Type”, “value”:”1”,
                                                        “valueCaption”:”Service Request”},
   {“key”:”computer_id”,”keyCaption”:”Asset ID”,“value”:”DELL-3PXZ15J”,
                                                            ”valueCaption”:”DELL-3PXZ15J”}]
 }
]

Return values definition

Get Service Request Form

Returns the information for the specified service record.

Parameters

Returns
The service record ID, user permissions to update/delete/archive the SR, and info fields according to the requested view and/or fields parameters. If none specified, return full service record information. Each info field contains metadata like: whether the field is mandatory, default value, whether it is editable, etc.

Sample JSON return value for /sr/273?fields=type,archive,update_time,status

{
    “id”:”273”,
    “canUpdate”:”true”,
    “canDelete”:”false”,
    “canArchive”:”false’,
    “info”: [{“key”:”sr_type”,
                 ”keyCaption”:”Service Record Type”,
                 ”value”:”1”,    
                 ”valueCaption”:”Service Request”,
                 ”mandatory”:true,
                 ”editable”:true,
                 ”type”:”list”,
                 ”defaultValue”:null},
               {“key”:”archive”,
                 ”keyCaption”:”Archive”,
                 ”value”:0,
                 ”valueCaption”:”0”,
                 ”mandatory”:false,
                 ”editable”:true,
                 ”type”:”boolean”,
                 ”defaultValue”:0},
                  {“key”:”update_time”,
                    ”keyCaption”:”Modify Time”,
                    ”value”:1391756438000,
                    ”valueCaption”:”2014-05-22 11:09:44”,
                ”mandatory”:false,
                ”editable”:true,
                ”type”:”date”,
                ”defaultValue”:null},
              {“key”:”status”,
                ”keyCaption”:”Status”,
                ”value”:1,                                                                   
                ”valueCaption”:”New”,
                ”mandatory”:true,
                ”editable”:true,
                ”type”:”list”,
                 ”defaultValue”:”New”}
}

Return values definition

Search Service Request

Returns a list of service requests (SR), that matched the search criteria. The number of SRs to return can be controlled by offset, limit, and type parameters. Returned SRs can be filtered by filters (See Filter Service). Each Service Request, includes the fields according to view and/or fields parameters. If none are specified, all SR fields are returned.

Parameters

Sample JSON /sr/search?query=54&view=SysAidMobile&limit=2

[
{
“id”:”5433”,
“canUpdate”:”true”,
“canDelete”:”false”,
“canArchive”:”false’,
“info”: [
{“key”:”title”,”keyCaption”:”Title”,”value”:”basic Service Request”, ”valueCaption”:”basic Service Request”},
{“key”:”insert_time”,”keyCaption”:”Request Time”,“value”:”13975648000”, valueCaption”:”2014-04-01 11:46:48”},
{“key”:”request_user”,”keyCaption”:”Request User”, “value”:”leo@law.com”,”valueCaption”:”Leonardo Gonzales”},
{“key”:”description”,”keyCaption”:”Description”, “value”:”Prezados Amos”, “valueCaption”:”Prezados Amos”},
{“key”:”sr_type,”keyCaption”:”Service Record Type”, “value”:”1”, “valueCaption”:”Service Request”}]
},
{
“id”:”5469”,
“canUpdate”:”true”,
“canDelete”:”false”,
“canArchive”:”false’,
“info”: [
{“key”:”title”,”keyCaption”:”Title”,”value”:”Relatório de ocorrência”, ”valueCaption”:”Relatório de ocorrência”},
{“key”:”insert_time”,”keyCaption”:”Request Time”,“value”:”1392026000”, valueCaption”:”2013-05-28 11:12:50”},
{“key”:”request_user”,”keyCaption”:”Request User”, “value”:”leo@law.com”,”valueCaption”:”Leonardo Gonzales”},
{“key”:”description”,”keyCaption”:”Description”, “value”:”Relatório de ocorrência”,“valueCaption”:”Relatório de ocorrência”},
{“key”:”sr_type,”keyCaption”:”Service Record Type”, “value”:”1”, “valueCaption”:”Service Request”}]
}
]

Return values definition

Update Service Request

Update a service request

Parameters

Payload:
A JSON string representing the service cords with the updated fields only.

Sample JSON input for/sr/273, update the status, add a note, change assigned to user & modify time

{
“id”:”273”,
“info”:
[{“key”:”update_time”, ”value”:1391756438000},
{“key”:”status”, ”value”:2},
{“key”:”notes”,”value”:[
{“userName”:”sysaid”,”createDate”:1391756438000,”text”:”Note 123”}
]},
{“responsibility”:66}]
}

Special Service Record Information Fields

The following object type fields can be modified through a different API call:

• Messages

• attachments

• links

• activities

Read-only fields: history, chats, department, CI relations, computer_name

Count Service Request

Returns the number of SRs that are compatible with the provided filters.

Parameters

Returns

Sample JSON return value for**/sr/count?computer_id=1

{
"count": 128
}

Return values definition

Close Service Request

Close a service record. Sets the service record status to the default Close status, as defined in the Help Desk settings.

Parameters

Payload:
A JSON string representing the solution.

Sample JSON input for /sr/6/close
{“solution”:”restart the computer…”}

Get Service Request Template

Get a new service record template.

Parameters

Returns
The service record information, according to the requested view and/or fields parameters. If none are specified, return full service record information. Each information field contains metadata like: whether the field is mandatory, default value, is it editable, etc.

Sample JSON return value for /sr/template?type=incident&template=39

{
  “id”:”0”,
  “info”: [{“key”:”request_user”,
              ”keyCaption”:”Request user”,
                 ”value”:149,    
                 ”valueCaption”:”shani1”,
                 ”mandatory”:true,
                 ”editable”:true,
                 ”type”:”list”,
                 ”defaultValue”:””},
               {“key”:”impact”,
                 ”keyCaption”:”Impact”,
                 ”value”:”Low”,
                 ”valueCaption”:”Low”,
                 ”mandatory”:false,
                 ”editable”:true,
                 ”type”:”list”,
                 ”defaultValue”:null},
                  {“key”:”status”,
                    ”keyCaption”:”Status”,
                    ”value”:”New”,
                    ”valueCaption”:”New”,
                ”mandatory”:true,
                ”editable”:true,
                ”type”:”list”,
                ”defaultValue”:2},
              {“key”:”title”,
                ”keyCaption”:”Title”,
               ”value”:”Cannot connect to a Wi-Fi network”,                                                                   
                ”valueCaption”:”Cannot connect to a Wi-Fi network”,
                ”mandatory”:true,
                ”editable”:true,
                ”type”:”text”,
                 ”defaultValue”:””}]
}

Return values definition

Create Service Request

Create a new service record and returns the newly created service record.

Parameters

Payload:
A JSON string representing the new service record.

Sample JSON input - set SR status, assigned to, due date, and add a note

{
  “info”: [{“key”:”due_date”, ”value”:1391756438000},
            {“key”:”status”, ”value”:2}
            {“key”:”problem_type”,“value”:“UserWorkstation_PC_Password” }
            {“key”:”notes”,”value”:[
            {“userName”:”sysaid”,”createDate”:1391756438000,”text”:”Note 123”}
             ]},
             {“responsibility”:66}]
}

Special Service Record Information Fields

Returns
The new service record information, according to the requested view and/or fields parameters. If none is specified, return the full service records information. Each info field contains metadata like: whether the field is mandatory, default value, whether it is editable, etc.

Sample JSON return value for POST /sr?view=Mobile&type=incident&template=39

{
  “id”:”45”,
  “info”: [{“key”:”request_user”,
              ”keyCaption”:”Request user”,
                 ”value”:149,    
                 ”valueCaption”:”shani1”,
                 ”mandatory”:true,
                 ”editable”:true,
                 ”type”:”list”,
                 ”defaultValue”:””},
               {“key”:”impact”,
                 ”keyCaption”:”Impact”,
                 ”value”:”High”,
                 ”valueCaption”:”High”,
                 ”mandatory”:false,
                 ”editable”:true,
                 ”type”:”list”,
                 ”defaultValue”:null},
                  {“key”:”status”,
                    ”keyCaption”:”Status”,
                    ”value”:”New”,
                    ”valueCaption”:”New”,
                ”mandatory”:true,
                ”editable”:true,
                ”type”:”list”,
                ”defaultValue”:2},
              {“key”:”title”,
                ”keyCaption”:”Title”,
                ”value”:”Cannot connect to a Wi-Fi network”,                                                               
                ”valueCaption”:”Cannot connect to a Wi-Fi network”,
                ”mandatory”:true,
                ”editable”:true,
                ”type”:”text”,
                 ”defaultValue”:””}]
}

Return values definition

After the service record is created, the following Object type fields can be added to the new service record through their different API calls:

• Messages

• Attachments

• Links

• Activities

Delete Service Request

Delete one or more service records

Parameters

Add Service Request Link

Add a link to a service record

Parameters

Payload
A JSON string representing the link.

Sample JSON input for /sr/6/link
{"name":"link2","link":"http://google.co.il"}

Delete Service Request Link

Delete a link from a service record.

Parameters

Payload
A JSON string representing the link name to delete

Sample JSON input for /sr/6/link
{"name":"link2"}

Add Service Request Attachment

Add an attachment to a service record.

Parameters

Payload
File Multipart/Form data.

Delete Service Request Attachment

Delete an attachment from a service record.

Parameters

Payload
A JSON string representing the attachment file ID to delete.

Sample JSON input for /sr/6/attachment
{"fileId":"111934645_312638760"}

Add Service Request Activity

Add an activity to a service record.

Parameters

Payload
A JSON string representing the new activity.

Sample JSON input for /sr/6/activity
{"userId":"sysaid","fromTime":"1378501200000","toTime":"1378846800000","description":"This is an activity from API"}

The total time is automatically calculated.

Delete Service Request Activity

Delete an activity from the service record

Parameters

Payload
A JSON string representing the deleted activity ID.

Sample JSON input for /sr/6/activity
{"id":2}

Send Message From Service Request

Send a message from a Service Record form.

Parameters

Payload
Multipart data including one or more files attached to the message, and a JSON string representing the new message.

Sample JSON input for /sr/6/message

{"fromUserId":"124","toUsers":"1,140,123,124","ccUsers":"3,125,127,[11]","msgSubject":"This is a message from API","msgBody":"Hello Hello Hello ......."}

Action Items

Get action items

Get a list of action items

Parameters

Returns
A list of action items

Sample JSON return value

[{
“id”:”24”,
“tabName”:”1”,
“subTabName”:”2”,
“hasApproved”:”true”,
“hasEmptyRequred”:”false”
},
{
“id”:”25”,
“tabName”:”1”,
“subTabName”:”2”,
“hasApproved”:”false”,
“hasEmptyRequred”:”false”
}]

Count Action Items

Count action items

Parameters

Returns
The number of action items.

Sample JSON return value

{
"count":24
   }

Approve Action Items

Approve action items

Parameters

Reject Action Items

Reject action items

Parameters

Complete Action Items

Complete action items

Parameters

Reopen Action Items

Reopen action items

Parameters

Assets

Get Assets List

Get a list of assets in SysAid.

Parameters

Returns
A list of assets. For each asset, returns the asset ID, asset name, group name, and information as defined in the view and/or fields parameters. If none of them exist, return full asset information.

Sample JSON return value for /asset?fields=computer_type,ip_address,serial&limit=2

[
    {
“id”:”497db453:147bee7ec09:-7ff2”,
       “name”:”ISA-VCHER-DW7”,
       “group”:”\”,
       “info”: [{“key”:”computer_type”,”key_caption”:”Type”,  
                    ”value”:”Workstation”,”value_caption”:”Workstation”},
                  {“key”:”ip_address”,”key_caption”:”IP Address”,  
                    “value”:”10.1.10.131”,“value_caption”:”10.1.10.131”},
                  {“key”:”serial”,“key_caption”:”Serial”,
                    “value”:”3PXZ15J”, “value_caption”:”3PXZ15J”}]
   },
   {
“id”:”9F38X-RDDTC-RHRXT-GX6XR-DDXRJ”,
       “name”:”VISTA-X64”,
       “group”:”\”,
       “info”: [{“key”:”computer_type”,”key_caption”:”Type”,  
                    ”value”:”Workstation”,”value_caption”:”Workstation”},
                  {“key”:”ip_address”,”key_caption”:”IP Address”,  
                    “value”:”10.1.10.30”,“value_caption”:”10.1.10.30”},
                  {“key”:”serial”,“key_caption”:”Serial”,
                    “value”:”4JS8L2J”, “value_caption”:”4JS8L2J”}]
   }
]

Return values definition

Get Asset

Get information on the specified asset.

Parameters

Returns
The asset ID, asset name, group name, and information as defined in the view and/or fields parameters. If none of them exist, return full asset information.

Sample JSON return value for /asset/497db453:147bee7ec09:-7ff2?fields=computer_type,ip_address,serial

{
“id”:”497db453:147bee7ec09:-7ff2”,
       “name”:”ISA-VCHER-DW7”,
       “group”:”\”,
       “info”: [{“key”:”computer_type”,”key_caption”:”Type”,  
                    ”value”:”Workstation”,”value_caption”:”Workstation”},
                  {“key”:”ip_address”,”key_caption”:”IP Address”,  
                    “value”:”10.1.10.131”,“value_caption”:”10.1.10.131”},
                  {“key”:”serial”,“key_caption”:”Serial”,
                    “value”:”3PXZ15J”, “value_caption”:”3PXZ15J”}]
   }

Return values definition

Search Asset

Get a list of assets in SysAid that matched the search criteria

Parameters

Returns
A list of assets that match the search criteria. For each asset, the command returns the asset ID, asset name, group name, and information as defined in the view and/or fields parameters. If none of them exist, return full asset info.

Sample JSON return value for /asset/search?query=DW7&fields=computer_type,ip_address,serial&limit=2

[
{
“id”:”497db453:147bee7ec09:-7ff2”,
“name”:”ISA-VCHER-DW7”,
“group”:”\”,
“info”: [{“key”:”computer_type”,”key_caption”:”Type”, ”value”:”Workstation”,”value_caption”:”Workstation”},
{“key”:”ip_address”,”key_caption”:”IP Address”, “value”:”10.1.10.131”,“value_caption”:”10.1.10.131”},
{“key”:”serial”,“key_caption”:”Serial”, “value”:”3PXZ15J”, “value_caption”:”3PXZ15J”}]
}
]

Return values definition

Lists

Get All Lists

Get all available lists and their values.

Parameters

Returns
The available lists, including their values, per entity type. Defaults to SR.

Sample JSON return value for list?entity=sr

{
 { “id”:”location”,
    “caption”:”Location”,
    “values”: [{“id”:”1”,”caption”:”Loc1”},
                   {“id”:”2”,”caption”:”Loc2”}]
 },
{ “id”:”impact”,
    “caption”:”Impact”,
    “values”: [{“id”:”1”,”caption”:”Very High”},
                   {“id”:”2”,”caption”:”Low”}]
 },
{ “id”:”urgency”,
    “caption”:”Urgency”,
    “values”: [{“id”:”1”,”caption”:”Urgent”},
                   {“id”:”2”,”caption”:”Normal”}]
 },
{ “id”:”priority”,
    “caption”:”Priority”,
    “values”: [{“id”:”1”,”caption”:”Highest”},
                   {“id”:”2”,”caption”:”High”},
                   {“id”:”3”,”caption”:”Low”}]
 },
{ “id”:”change_category”,
    “caption”:”Classification”,
    “values”: [{“id”:”1”,”caption”:”Minor”},
                   {“id”:”2”,”caption”:”Significant”},
                   {“id”:”3”,”caption”:”Major”}]
 },
{ “id”:”survey_status”,
    “caption”:”Survey Status”,
    “values”: [{“id”:”1”,”caption”:”Not Sent”},
                   {“id”:”2”,”caption”:”Sent”}]
 },
{ “id”:”sr_type”,
    “caption”:”Service Record type”,
    “values”: [{“id”:”1”,”caption”:”Change”},
                   {“id”:”2”,”caption”:”Problem”},
                   {“id”:”3”,”caption”:”Incident”},
                   {“id”:”4”,”caption”:”Request”}]
 },
{ “id”:”responsibility”,
    “caption”:”Assigned to”,
    “values”: [{“id”:”3”,”caption”:”SysAid”},
                   {“id”:”124”,”caption”:”QA-LAB\Administrator”}]
 },
{ “id”:”status”,
    “caption”:”Status”,
    “values”: [{“id”:”1”,”caption”:”Open”},
                   {“id”:”2”,”caption”:”Closed”}]
 },
{ “id”:”company”,
    “caption”:”Company”,
    “values”: [{“id”:”1”,”caption”:”Company 1”},
                   {“id”:”2”,”caption”:”Company 2”}]
 },
{ “id”:”department”,
    “caption”:”Department”,
    “values”: [{“id”:”1”,”caption”:”IT”},
                   {“id”:”2”,”caption”:”R&D”}]
 },
{ “id”:”agreement”,
    “caption”:”Agreement”,
    “values”: [{“id”:”1”,”caption”:”DEFAULT SLA”},
                   {“id”:”2”,”caption”:”Agreement 2”}]
 },
{ “id”:”source”,
    “caption”:”Source”,
    “values”: [{“id”:”1”,”caption”:”Administrator Portal”},
                   {“id”:”2”,”caption”:”Agent”},
                   {“id”:”3”,”caption”:”Email”},
                   {“id”:”4”,”caption”:”Chat”}]
 },
{ “id”:”cust_list1”,
    “caption”:”SR Custom list 1”,
    “values”: [{“id”:”1”,”caption”:”Cust Val 1”},
                   {“id”:”2”,”caption”:”Cust Val 2”}]
 },
{ “id”:”cust_list2”,
    “caption”:”SR Custom list 2”,
    “values”: [{“id”:”1”,”caption”:”Cust Val 3”},
                   {“id”:”2”,”caption”:”Cust Val 4”}]
 },
}

Return values definition

Get List

Returns the values of the specified list. Values may be filtered according to the entity (sr, asset, etc.) for which you populate the list values.

Parameters

Returns
The available lists, including their values, per entity type. Defaults to SR.

Sample JSON return value for list/responsibility?entity=sr&entityid=6

{ “id”:”priority”,
“caption”:”Priority”,
“values”: [{“id”:”1”,”caption”:”Highest”},
{“id”:”2”,”caption”:”High”},
{“id”:”3”,”caption”:”Low”}]
}

Return values definition

Add-ons

List application add-ons

Get a list of all available add-ons.

Parameters

This API doesn’t receive any parameters.

Returns
Return a list of available add-ons.

Sample JSON return value for add-ons

[
 {
   "name": "sage",
   "title": "Sage ERP X3",
    "description": "The Sage Identity Management System(AIMS) Ticketing Integration app allows AIMS to create, update and automate",
   "logoFileName": "images/bomgarLogo.png",
   "version": 1,
   "addonType": "Remote Control",
   "link": "http://www.sysaid.com/doc/installSage.html",
   "linkText": "Sage installation instructions",
   "active": false,
   “implemented”: true,
   “params”: null
 },
 {....}
]

Return values definition

Get add-on parameters

Returns the full information about an addon with all it’s parameters.

Parameters

Returns
The add-on with all its parameters.

Sample JSON return value for /addons/bomgar

{
   "name": "bomgar",
   "title": "Bomgar",
   "description": "Bomgar i a provider of secure remote support solutions that enable technology professionals",
   "logoFileName": "addons/bomgar/images/bomgarLogo.png",
   "version": 1,
   "addonType": "Remote Control",
   "link": "https://www.sysaid.com/tools/third-party-integrations",
   "linkText": "",
   "active": true,
   "implemented": true,
   "params": [
       {
           "name": "bomgar_url",
           "description": "Bomgar RC integraton URL",
           "value": "https://sysaid.bomgar.com",
           "type": "text",
           "mandatory": true,
           "editable": true,
           "encrypted": false
       },
       {
           "name": "bomgar_user_name",
           "description": "Bomgar User Name",
           "value": “MyBomgarUserName”,
           "type": "text",
           "mandatory": true,
           "editable": true,
           "encrypted": false
       },
       {
           "name": "bomgar_password",
           "description": "Bomgar Password",
           "value": “MyPassword”,
           "type": "text",
           "mandatory": true,
           "editable": true,
           "encrypted": true
       }
   ]
}

Return values definition

Update add-on parameters

Update an add-on parameters

Parameters

Payload:

A JSON string representing the add-on parameters with the update values. The list below will contain only the fields that can be updated. Any changes to other fields are ignored.

Sample JSON input /addon/bomgar, update the user name and password fields

{
   "name": "bomgar",
   "active": true,
   "params": [
       {
           "name": "bomgar_url",
           "value": "https://sysaid.bomgar.com",
       },
       {
           "name": "bomgar_user_name",
           "value": "MyUserName",
       },
       {
           "name": "bomgar_password",
           "value": "MyPassword",
       }
   ]

Returns
New http header with success message or error text.

Test add-on connection

Test the add-on parameters.

Parameters

Payload
A JSON string representing the add-on parameters to test. The list below will contain only the fields that can be checked. Any changes to other fields are ignored.

Sample JSON input /addon/bomgar/testConnection, test the parameters for bomgar addon

{
   "name": "bomgar",
   "active": true,
   "params": [
       {
           "name": "bomgar_url",
           "value": "https://sysaid.bomgar.com",
       },
       

           "name": "bomgar_user_name",
           "value": "MyUserName",
       },
       {
           "name": "bomgar_password",
           "value": "MyPassword",
       }
   ]
}

Returns
New HTTP header with a success message or error text.

Refresh Add-ons List

Refresh the addons list immediately.

Parameters

None

Returns
Upon successful refresh, return a message and a success status.

CIs

Create CI

Create a CI

Payload

A JSON string representing the CI with the updated fields only.

Sample JSON post params for POST/ci

{
   "info": [
            {"key":"ci_name","value":"Test CI from api 1"},
            {"key":"ci_type", "value":"69"},
            {"key":"company", "value":"3"},
            {"key":"ci_cust_text_1","value":"test short text entry"},
            {"key":"ci_cust_date_1", "value":"1636282614000"}
            ]
}

Get CI List/Form

Returns a list of CIs that can be filtered by the available filters.
The Number of CIs to return can be controlled by the Offset and Limit parameters.

Returned CIs can be filtered.

Each CI includes the fields according to the View and Fields parameters. If none are specified, all CI fields are returned.

Parameters

Returns
A list of CIs. For each CI, an ID is returned with the info fields defined in the view and/or fields parameters. If no fields are specified, it returns the full CI information.

Sample JSON return value for /ci/barcode?view=SysAidMobile&fields=ci_name,location&limit=2

[
{
 “id”:”5433”,
…….
 }
]

Return values definition

Update CI

Update a CI.

Parameters

Payload
A JSON string representing the CI with the updated fields only.

Sample JSON input /ci/273, update the status, change owner & accept date

{
  “id”:”273”,
  “info”: [{“key”:”accept_date”, ”value”:1391756438000},
            {“key”:”status”, ”value”:2},
             {“owner”:”sysaid”}]
}

Get CI Types

Returns the available CI types.
If the barcode flag is requested, it returns only CI types with barcode support (if the add-on is available).

Parameters

Returns
A list of CI types. Each type includes its ID, name, description, and whether the type is predefined.

Sample JSON return value for ci/type

[
    {
“id”:”53”,
       “name”:”Administrator”,
       “description”:””,
       “predefined”: “true”
   },
    {
“id”:”1”,
       “name”:”Asset”,
       “description”:”System Asset
                         (Workstation,Server,Laptop,Printer,PDA,Other)”,
       “predefined”: “true”
   },
    {
“id”:”6”,
       “name”:”Business Process”,
       “description”:””,
       “predefined”: “false”
   },
    {
“id”:”7”,
       “name”:”Catalog”,
       “description”:”System Asset Catalog”,
       “predefined”: “true”
   },
    {
“id”:”52”,
       “name”:”End User”,
       “description”:””,
       “predefined”: “true”
   }
]

Return values definition

Get CI View

Returns the fields contained in the specified view.

Parameters

Returns
A list of fields with the requested view.

Sample JSON return value for /ci/view/180?view=barcode_book

[
   {
       "key": "ci_type",
       "value": null,
       "mandatory": false,
       "editable": false,
       "type": "list",
       "defaultValue": null,
       "displayOrder": 1,
       "keyCaption": "CI Type",
       "valueCaption": null
   },
   {
       "key": "owner",
       "value": null,
       "mandatory": false,
       "editable": true,
       "type": "list",
       "defaultValue": null,
       "displayOrder": 2,
       "keyCaption": "Owner",
       "valueCaption": null
   },
    {

     ………
    },
   {
       "key": "id",
       "value": null,
       "mandatory": false,
       "editable": true,
       "type": "numeric",
       "defaultValue": null,
       "displayOrder": 14,
       "keyCaption": "#",
       "valueCaption": null
   }
]

Return values definition

Get CI Relation Types

An API for retrieving CI relation type definitions.

Returns
Returns all the valid CI relation types defined in the SysAid database and their ID numbers.

Sample JSON return value for ci/relationtypes

[
   {
    "relationTypeId": 5,
    "relationName": "Accessed by",
    "oppositeRelationName": "Can access"
   },
   {
    "relationTypeId": 4,
    "relationName": "Connected to",
    "oppositeRelationName": "Connected to"
   }
]

Return values definition

Get CI Relation

An API to retrieve all the destination CIs and their relation types, which are associated with a given CI ID.

Returns
Returns a list that contains all the destination CI and their prospective CI relationship types associated with the CI ID.

Sample JSON return value for /ci/9/relation

[
   {
      "src": 9,
      "dest": 1,
      "ciRelationType": 2
   },
   {
     "src": 9,
     "dest": 2,
     "ciRelationType": 3
},
    {
     ………
    },
   {
    "src": 9,
    "dest": 5,
    "ciRelationType": 5
   }
]

Return values definition

Create CI Relations

API for creating one or more relations for a given CI ID.

Parameters

An array of one or more objects comprising of the following fields in each element

Returns
OK if all relations in the list have been generated successfully, or if the relations already exist in the system (does not generate duplicates in the database)
An exception is thrown, containing a parsable (.csv format) string of the relations in the list that failed the creation process.

Sample JSON post params for /ci/9/relation

[
 {
    "dest":2,
    "ciRelationType":3
 },
 {
    "dest":1,
    "ciRelationType":2
 },
 {
    "dest":3,
    "ciRelationType":11
  }
]

Sample error message for a partially failed list

{
 "status": 400,
 "message": "Ci:9 Invalid CI id 100,Ci:9 Invalid CI Relation type 11"
}

Delete CI Relations

API for deleting one or more relations for a given CI ID.

Parameters

An array of one or more objects comprising of the following fields in each element

Returns
Always returns OK (unless the user is not logged in or is not authorized to perform the call), even if non-existent CI relations or CI destinations were passed to the API

Sample JSON post params for /ci/9/relation

[
 {
    "dest":2,
    "ciRelationType":3
 },
 {
    "dest":1,
    "ciRelationType":2
 },
 {
    "dest":3,
    "ciRelationType":11
  }
]

Resource Bundle

Get RB Translated Keys

Get an array of translated keys according to the account location.

Parameters

None.

Payload
A JSON string representing an array of Resource Bundle keys.

Sample JSONinput /rb

[
 {
   "key":"dir"
 }
]

Returns
A list of translated keys.

Sample JSON return value for /rb

[
 {
     key: "dir"
     value: "LTR"
 }
]

Return values definition

Get RB Translated Keys With Given Location

Get an array of translated keys according to the given location.

Parameters

Payload
A JSON string representing an array of Resource Bundle keys.

Sample JSON input /rb

[[
 {
   "key":"dir"
 }
]

Returns
A list of translated keys.

Sample JSONreturn value for /rb/{locale}

[
  {
    key: "dir"
    value: "LTR"
  }
]

Return values definition

Password Services

Get LDAP Domains

Get LDAP domains.

Parameters

None.

Payload

None.

Returns
A list of LDAP domains.

Sample JSON return value for /ps/domain

["ILIENT-HQ","PM-TEST","QA-LAB"]

Return values definition
List of domains as an array of strings.

Get Password Services Permission

Retrieves a list of all Password Services permissions.

Parameters

None.

Payload

None.

Returns
JSON representing Password Services permission.

Sample JSON return value for /ps/permission

{
enableUserSelfServices: true
enableUnlockAccount: true
enableResetPassword: true
enableLdapSupport: true
enableUserReset: false
}

Return values definition

Get Security Question

Get a list of all security questions for a given user.

Parameters

Payload
A JSON string representing the userName and domain name.

Returns
JSON representing the Security Questions object.

Sample JSON return value for /ps/reset/question

{
   "userRefId": 842,
   "userId": "QA-LAB\\test11",
   "userSecurityQuestionsList": [
       {
           "id": 1,
           "question": "In which city were you born?"
       },
       {
           "id": 2,
           "question": "In which state were you born?"
       },
       enableCaptcha: true
   ]
}

Return values definition

Unlock Account

Unlock an account for a specific user upon answering security questions.

Parameters

None.

Payload
A JSON string representing the user’s answers.

Returns
JSON representing unlock action response.

Sample JSON return value for /ps/unlock

{
   “actionMessage” : Unlock user account succeeded! \\n Please use your current password to login
}

Return values definition

Reset password

Reset a user's password upon answering security questions.

Parameters

None.

Payload
A JSON string representing the user’s answers.

Returns
JSON representing the reset action response.

Sample JSON return value for /ps/reset/ with reset method = “email”

{
   "actionMessage": "Reset user password succeeded!\\nWithin the next few moments, you will receive an email with your new temporary password.\\nThis password is only valid for 20 minutes, so please log in with it immediately.\\nUpon login, you will be asked to choose a new, permanent password.",
   "settings": {
       "temporaryPasswordValidity": 20,
       "resetPasswordMethod": "email"
   }
}

Return values definition

Sample JSON return value for /ps/reset with reset method = “user”

{
   "policy": {
       "complexity": true,
       "minLength": 7,
       "historyLength": 24
   },
   "token": "9f5641643c7f49b9920823ba18381a05"
}

Return values definition

Update Password

Manually update a user's password upon verifying the user's token

Parameters

None.

Payload
A JSON string representing the update password request object.

Returns
JSON representing the Update Password action response.

Sample JSON return value for /ps/reset/update

{
actionMessage: "Reset user password succeeded!"
}

Return values definition

Non-Resource scenarios

API calls that send a response that's not necessarily a resource.

Download File

Download a file from the server. For example: download a user’s photo.

Parameters

Return values definition

Translate Key

Translate a key for display in the specified language.

Parameters

Returns
The translated string.

Sample JSON return value for a file

{
   “key”:”welcome”,
   “value”:”Bienvenue”
}

Return values definition

Download Daily Database Backup

This endpoint returns a direct download link for the latest available daily database backup file. The link is valid for a limited time and will trigger the file download when accessed.

While it can be used manually, it’s primarily intended to support automated workflows. You can create a scheduled script that retrieves the latest backup each day and feeds it directly into your BI or analytics tools, enabling richer, external reporting based on your SysAid data.

Please note:

• Only SysAdmin users are authorized to access this endpoint. Authentication is required prior to use. See the Login section.

• You must allow for backup delivery in your SysAid account. To do so, please contact your SysAid representative.

Endpoint:

GET /api/v1/dbbackup

Exmaple URL:

https://<your_subdomain>.sysaidit.com/api/v1/dbbackup

Response:

The response returns a 200 OK with a JSON body that includes the download link to the latest database backup.

{
  "downloadUrl": "https://csmp.sysaid.com/api/download_backups?account_id=yourcompany&uuid=some-id&token=your-token"
}

You can paste the downloadUrl in your browser to download the .zip backup file. The link will return “NO_DATA” if none exist in SysAid.