Skip to main content

SysAid API

Write your own code to create, retrieve, update, and delete SysAid entities, integrating SysAid with your other applications.

  • 80 Posts
  • 214 Replies
80 Posts
D
DavidMcGawnNew SysMate
posted in SysAid API
Login Working Now How to Create a /Sr via API

had anyone got any JavaScript examples of how to create a sr request via api. i can get logged in and get the jsessionid back. just need to know the next steps to create an actual request Thanks David

1702
A
Community Enthusiast
P
Community Enthusiast
PederoCommunity Enthusiast
asked in SysAid API
SysAid CMDB Sync With VMware Vcentre hosted CIs

Hi guys, we are looking at syncing our virtual assets on vcentre with SysAid CMDB. Has anyone done this before? your guide will be appreciated. 

1079
Maayan Karstaedt
SysAider
G
Gabriel1321New SysMate
asked in SysAid API
Database API

Hello everyone! I'm new here and I was wondering, does anyone know if there's a premade way here in SysAid to connect SysAid to a database or related? I would be glad if someone could answer. Thank you in advance.

3258
Maayan Karstaedt
SysAider
C
CsandbNew SysMate
asked in SysAid API
Request for further details regarding REST API in general

Hello!We are in the middle stages of evaluation of SysAid as a combined ITSM and CMDB service for both internal and customer needs. Internally we have a strong philosophy of consolidating as much frontend-backend communication to REST as possible; as such, we are heavily invested in wanting to know more about the API of SysAid in general.  The main sources of relevant information regarding the REST API we have perused are the following:https://documentation.sysaid.com/docs/rest-api-guidehttps://documentation.sysaid.com/docs/rest-api-details Rather than asking what is possible, we thought it would be easier if it’s possible to define which parts of the system are not accessible (e.g. replicating full functionality supplied via other existing methods) via REST? As an example, we found the documentation for creating CIs in this manner to be just about non-existing.  To summarise, what, if any limitations are in place for the REST API and, if existing, what are underlying causes and/or pre

2042
C
C
CCDNew SysMate
asked in SysAid API
powershell script with Rest API integration

Does anyone have a working powershell script with Rest API integration. I am looking for a possibility to populate the solution field and the activity field from Powershell.

5963
C
B
BeckhoffGuyNew SysMate
asked in SysAid API
REST API Search SR not returning project_id

Hello. I am trying to do a search of our service records using the REST API. I am able to successfully login and do a sr search. I retrieve all the records but I am missing a piece of data I would like to display to my users from this search.  On our system I would like to retrieve this piece of information.   If I do a request and pull this record individually, the data is in the key “project_id”.  This is missing from a sr search. Is it possible to request this field in my query? Do I need to define a view or something like that? I tried adding parameter's to my request in the field parameter but that didn’t seem to help. Our default view does show this information. Or do I need to write a loop from the first search to pull each sr and find that piece of data that was missing? This is my search request to start with that seems to return everything I need but one field.  Thank you. 

1735
Erik Snider
SysAider
R
RRivNew SysMate
posted in SysAid API
REST API - login timeouts

Hi, since two days login calls to REST API have stopped working, everytime I POST /login (as I always did) i receive a "Error 504 - Request time out". If I try logging in from a web browser, I can then call other get endpoints from there so API is actually working. What could it be? Thanks!

941
E
Community Enthusiast
F
FelixTheCatNew SysMate
asked in SysAid API
SysAid REST API Returns Incorrect Value

The standard key field ‘totalTime’ always returns the SR# and not the Total Activities time (sum of the time in SR’s activities). Please fix/advise. REST API Return Values[{"id":"226","canUpdate":true,"canDelete":false,"canArchive":false,"hasChildren":false,"info":[{"key":"totalTime","value":226,"valueClass":"","valueCaption":"226","keyCaption":"Total Activities time"}]},{"id":"303","canUpdate":true,"canDelete":false,"canArchive":false,"hasChildren":false,"info":[{"key":"totalTime","value":303,"valueClass":"","valueCaption":"303","keyCaption":"Total Activities time"}]},{"id":"781","canUpdate":true,"canDelete":false,"canArchive":false,"hasChildren":false,"info":[{"key":"totalTime","value":781,"valueClass":"","valueCaption":"781","keyCaption":"Total Activities time"}]},{"id":"1950","canUpdate":true,"canDelete":false,"canArchive":false,"hasChildren":false,"info":[{"key":"totalTime","value":1950,"valueClass":"","valueCaption":"1950","keyCaption":"Total Activities time"}]},{"id":"2010","can

1354
Sela Weinrob
SysAider
F
fquirozNew SysMate
posted in SysAid API
Login rest api End-User

Hi! im trying to login with a End-user account, is that even possible? that's how I'm trying: my Url http://myurl.com/api/v1/login Header: Content-Type: application/json Body: { "user_name":"end_user_name", "password":"end_user_psw"} return (error): { "status": 401, "message": "No Mobile App Permission" }

4364
E
Community Enthusiast
D
DomBurke-ThePoolsNew SysMate
asked in SysAid API
Issues Posting to the Change Request Endpoint

Hi, I'm trying to send a request to the Change End Point http://helpdesk:8080/api/v1/sr?type=change&templateID=1 and I am getting the following error back Status 400 - Message 'Failed to load service record template:5' I am able to successfully post a Request using the end point http://helpdesk:8080/api/v1/sr?type=request&templateID=12 Any ideas what is going wrong please?

961
Maayan Karstaedt
SysAider
jonys_coelho
jonys_coelhoNew SysMate
posted in SysAid API
REST API Attachment

Hey everyone, Can anyone tell me please how can I make a attachment request through REST API? I am using the /sr/{id}/attachment url to add a new attachment to a service record. Thanks in advance.

5870
C
D
Community Enthusiast
DerekVMSCommunity Enthusiast
posted in SysAid API
not recieving a JSESSION cookie upon login in REST API

HI, I'm using postman to test the REST API and using interceptor to store the cookie that is sent back My cookie that I receive from the login endpoint looks like this: SERVERID=inst05us-autoscale-app3|Ye8OW|Ye8Ny I do see this cookie included in my headers when trying to hit the SR endpoint to test, but I receive a 401 error saying I need to login to sysaid first. The documentations leads me to believe that i need to be receiving a JSESSIONID cookie but that doesn't seem to be what I'm getting back?

2780
Maayan Karstaedt
SysAider
T
tcoxNew SysMate
posted in SysAid API
API - Why can't we update assets?

Why does Sysaid not have functionality to update an asset via API? You can update a CI but then our Asset and CI information do not match. If we were allowed to update an asset then the system would sync over that update to the CI. I think something needs to change... rather allow us to update an asset or for the CI and Assets to synchronize in both directions.

800
T
phamjp
phamjpNew SysMate
posted in SysAid API
SysAid API PowerShell trying to create a SR from template

Hello all, can someone let me where the Java message come from? And how to resolve my code? I just wanting to create a SR request from a template. ---My code-- [Net.ServicePointManager]::SecurityProtocol = "Tls, Tls11, Tls12, Ssl3" $sysAidURI = "https://mycompany.sysaidit.com/api/v1" Invoke-WebRequest -Uri "$sysAidURI/login" -ContentType "application/json" -Body '{"user_name": "username", "password": "password"}' -Method 'POST' -SessionVariable websession $Body= '{ "info": [{"key":"due_date", "value":1646857974017}, {"key":"status", "value":2}, {"key":"problem_type","value":"Vulnerability Management"}, {"key":"notes","value":[ {"userName":"sysaid","createDate":1646857974017,"text":"Note 123"} ]}, {"responsibility":35}] }' $Data = Invoke-RestMethod -uri "$sysAidURI/sr?type=request&template=145" -WebSession $websession -method POST -ContentType application/json -Body $Body ---And the terminal

2190
Maayan Karstaedt
SysAider
T
tcoxNew SysMate
posted in SysAid API
Rest API - Asset Name

There doesn't seem to be a good key that contains the Asset's name when viewing the details. It does list the Asset ID in multiple keys but I am needing the name of the Asset. It also does have the Asset name as part of the "network" key but that doesn't seem to always be the case. Is there something I'm missing? For instance: An Asset with the host name "PBNETWORK-1" can be queried by the API using the hostname. But the results from the query do not return any keys with the host name value. Instead the keys are of the Asset ID which in this case is something like "DELL-DNDM999".

550
T
S
skarimiNew SysMate
posted in SysAid API
get information via REST api in python

hi there I have problem when I want to get information via REST in python requests I don't know which protocol should I use for Authentication from browser I can get api responses because I can logged in via login page but in python code I can't login because in python I have to define api authentication protocol for example oauth1 or basic or ... I tested with basic authentication but I got error I guess sysaid doesn't support basic auth please help

2020
Maayan Karstaedt
SysAider
A
Anonymous
posted in SysAid API
Internal error during incident update via RestAPI in C#

Hello, I'm trying to update an incident via RestAPI within my C# application, but i get an error message: {"status":500,"message":"null"} Below you can see what code i use public void saUpdateTicket(string saTicket, string TDTicket) { string someUser = "********"; string someAccount = "*******"; string somePass = "*********"; SysaidUpdate saUpdate = new SysaidUpdate(); saUpdate.id = saTicket; var objLogin = new Login(someUser, someAccount, somePass); var client = new RestClient("https://<SERVER>:8443/api/v1"); var loginRequest = new RestRequest("login", Method.POST); loginRequest.AddJsonBody(objLogin); var responseLogin = client.Execute(loginRequest); client.CookieContainer = new System.Net.CookieContainer(); var authCookie = responseLogin.Cookies.First(a => a.Name == "JSESSIONID"); client.CookieContainer.Add

1110
Maayan Karstaedt
SysAider
J
JPiresNew SysMate
posted in SysAid API
REST API retrieve attachment file

I would like to ask how can I retrieve the attached file from Service Directory? I haven't found how I can use the REST API to retrieve the attached file.

1100
Maayan Karstaedt
SysAider
P
Phil_PLEXNew SysMate
posted in SysAid API
Updating Service Record via REST API

Hi Guys, I'm fairly new to SysAid and have been getting to grips with using Powershell to retrieve and update service records. I've been successful in the former, however when attempting to update records I am running into an issue. The script runs without error and viewing the ticket history in the browser shows that it has been updated, but the actual fields don't appear to update at all. Example below: $body = '{"id":"123456","info":[{"key":"priority","value":"0"}]}' Invoke-restmethod -uri https://companynamehere.sysaidit.com/api/v1/sr/123456 -WebSession $session -method put -ContentType application/json -body $body The scenario is that we have a number of old tickets that have an out of date priority set and we need to change them to a new one before we disable or delete the invalid priority. Has anyone else had this issue and been able to overcome it? Any help appreciated, thanks.

2540
P
I
insertNew SysMate
posted in SysAid API
API request ps/reset/ Reset password

What is the correct query ? {"userRefId":12,"userSecurityQuestionsList":[{"id":18,"question":"------", "answer":"1234"}] }

330
I
K
kennedysousaNew SysMate
posted in SysAid API
SysAid REST API - Action Items

According to the documentation, we should be able to retrieve the action items for a given service request using the following URL: GET/action_item?view={view_name}&fields={field1,field2..}&type={type}&archive={archive}&ids={id1,id2..}&staticFilterId={filter_id}&{filter1}={filter1_value}&{filter2}={filter2_value}...&query={search_criteria}&offset={offset}&limit={limit}&sort={field}&dir={dir}... The only required parameter is ids - a list of comma separated SR IDs to return their action items. However, when I issue an authenticated request to the URL above, I always get a 500 response code with the payload below: {'status': 500, 'message': None} What could be causing the server side error? References: https://community.sysaid.com/Sysforums/posts/list/13563.page#ActionItem https://community.sysaid.com/Sysforums/templates/default/help/files/Guide_REST_API_Details.htm#Getactionitems

2270
K
S
Community Enthusiast
SyedHassanCommunity Enthusiast
posted in SysAid API
Unable to create SR with 3 Category levels via REST API

Hi Im trying to create an SR using the REST API via Postman (initially), however although the SR is created not all the fields are updated. I know the values exist and match in the SysAid system. From the below sample JSON, the problem_sub_type and third_level_category fields, and the custom field CustomColumn405sr date/time field don't update (also tried the update SR API - I get the same result). POST /api/v1/sr/ application/json { "info": [ {"key":"problem_type","value":"Backup"}, {"key":"problem_sub_type","value":"Generator"}, {"key":"third_level_category","value":"Fault"}, {"key":"title","value":"Test SR"}, {"key":"description","value":"Generator"}, {"key":"impact","value":"4"}, {"key":"urgency","value":"4"}, {"key":"CustomColumn405sr", "value" : 1617788641080} ] } Create API returned 200 Ok and the JOSN of the created SR. Update API returns 200 Ok and '1' in the response body. Please can som

1600
S
SysAider
G
Community Enthusiast
giosalCommunity Enthusiast
posted in SysAid API
List of all software installed by Get or Post [HTTP rest api]

Hello. I installed Sysaid on a server and installed the agent on all the machines in my LAN. I would like to know if it is possible to have a complete list of all the software installed on all the machines of the LAN using the POST or GET calls thank you

430
M
S
Community Enthusiast
SyedHassanCommunity Enthusiast
posted in SysAid API
Retrieve Attachment via REST API

Hi Could someone advise what REST API call I use to download/retrieve attachments against an SR? Thanks in advance

690
S
Community Enthusiast
S
Community Enthusiast
SyedHassanCommunity Enthusiast
posted in SysAid API
Error 500 - "message": "Failed to load list of service records"

Hi all, I'm using Postman and when calling the API (GET /...sr?view=CAFM Update) to get a list of SRs matching the 'CAFM Update' view, I get an error 500 response: { "status": 500, "message": "Failed to load list of service records" } I can successfully use the GET /...sr?view=CAFM New API call to return SRs matching that view. Could someone advise what the error means and how to resolve it? If I try to use the 'CAMF Update' view in SysAid portal, I don't get any results - could this me what the message is saying? This is an issue I need resolving ASAP so grateful for any advise you can offer. Thanks

440
S
Community Enthusiast

Badge winners

Show all badges
Terms & ConditionsCookie settings