HaloITSM

the haloitsm connector facilitates the integration of haloitsm's it service management capabilities with swimlane's security automation workflows haloitsm is a comprehensive it service management solution that streamlines incident, problem, and change management this connector enables swimlane turbine users to automate itsm processes, such as ticket management, agent actions, and it asset tracking, directly within the swimlane platform by integrating with haloitsm, security teams can enhance their incident response capabilities, reduce manual overhead, and improve overall service delivery efficiency prerequisites to effectively utilize the haloitsm connector within swimlane turbine, ensure you have the following prerequisites oauth 2 0 client credentials for secure authentication, which requires url the endpoint url for haloitsm api access client id your unique identifier issued by haloitsm for api access client secret a secret key provided by haloitsm to authenticate your api requests scopes specific permissions granted for api access to various features within haloitsm capabilities the haloitsm connector has the following capabilities add attachments get action by id get actions get agent by id get agents get array of ticket types get halo site by id get halo sites get report by id get reports get status by id get team by id get team names get ticket by id get ticket statuses and so on api documentation link for more information on haloitsm is found at haloitsm api documentation https //halo haloservicedesk com/apidoc/info configurations haloitsm oauth 2 0 client credentials authenticates using oauth 2 0 client credentials configuration parameters parameter description type required url a url to the target host string required tenant id the tenant id string optional client id the client id string required client secret the client secret string required scope permission scopes for this action array required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions add attachments adds new or updates existing attachments in haloitsm requires base64 format; updates if id is present, otherwise creates endpoint url /api/attachment method post input argument name type required description input argument name type required description id number optional ticket id filename string optional file name datecreated string optional date created note string optional note filesize number optional size of the file type number optional type unique id number optional unique id desc string optional desc data string optional data ticket id number optional ticket id action id number optional action id user id number optional user id agent id number optional agent id attachmentaction id number optional attachment action id canupdate boolean optional canup date warning string optional warning showforusers boolean optional show for users data base64 string optional data base64 content output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 200, "response headers" { "date" "wed, 19 jun 2024 07 06 15 gmt", "content type" "application/json; charset=utf 8", "content length" "16093", "connection" "keep alive", "cache control" "no cache, no store, must revalidate", "server" "", "request context" "appid=cid v1\ a16f5763 e566 48d2 8ad2 e172951888ad", "x content type options" "nosniff", "strict transport security" "max age=31536000; includesubdomains; preload" }, "reason" "ok", "json body" {} } ] get action by id retrieves a specific action from haloitsm using a unique identifier, requiring the 'id' as a path parameter endpoint url /api/actions/{{id}} method get input argument name type required description input argument name type required description id number required unique identifier agentonly boolean optional parameter for get action by id emailonly boolean optional parameter for get action by id includedetails boolean optional parameter for get action by id includeemail boolean optional parameter for get action by id mostrecent boolean optional parameter for get action by id nonsystem boolean optional parameter for get action by id penultimate boolean optional parameter for get action by id ticket id number optional unique identifier output parameter type description parameter type description status code number http status code of the response reason string response reason phrase note html string output field note html ticket id number unique identifier id number unique identifier outcome string output field outcome who string output field who who type number type of the resource who imgpath string output field who imgpath who agentid number unique identifier datetime string time value note string output field note emailbody string request body data emailsubject string output field emailsubject emailbody html string request body data actionuserdef number output field actionuserdef userdesc string output field userdesc actiondatecreated string output field actiondatecreated actioninvoicenumber string output field actioninvoicenumber externalinvoicenumber number output field externalinvoicenumber actionchargeamount number output field actionchargeamount actionchargehours number output field actionchargehours actionnonchargeamount number output field actionnonchargeamount actionnonchargehours number output field actionnonchargehours example \[ { "status code" 200, "response headers" { "cache control" "no cache", "transfer encoding" "chunked", "content type" "application/json", "date" "mon, 29 apr 2024 05 54 47 gmt" }, "reason" "ok", "json body" { "note html" "string", "ticket id" 0, "id" 0, "outcome" "string", "who" "string", "who type" 0, "who imgpath" "string", "who agentid" 0, "datetime" "2019 08 02t14 35 54 437z", "note" "string", "emailbody" "string", "emailsubject" "string", "emailbody html" "string", "actionuserdef" 0, "userdesc" "string" } } ] get actions retrieves a count and array of action objects from haloitsm, offering an overview of available actions endpoint url /api/actions method get input argument name type required description argument name type required description actoutcome string optional parameter for get actions actoutcomenum number optional parameter for get actions agentonly boolean optional parameter for get actions conversationonly boolean optional parameter for get actions count number optional count value datesearch string optional parameter for get actions enddate string optional date value excludebilling boolean optional parameter for get actions excludehiddenfrominternalit boolean optional unique identifier excludeprivate boolean optional parameter for get actions excludesys boolean optional parameter for get actions importantonly boolean optional parameter for get actions importanttop boolean optional parameter for get actions includeagentdetails boolean optional parameter for get actions includeattachments boolean optional parameter for get actions includefacebookfields boolean optional parameter for get actions includehtmlemail boolean optional parameter for get actions includehtmlnote boolean optional parameter for get actions includenonactionattachments boolean optional parameter for get actions includetranslations boolean optional parameter for get actions includetwitterfields boolean optional parameter for get actions intraticketonly boolean optional parameter for get actions ischildnotes boolean optional parameter for get actions isrelatednotes boolean optional parameter for get actions output parameter type description parameter type description status code number http status code of the response reason string response reason phrase ticket id number unique identifier record count number count value actions array output field actions ticket id number unique identifier id number unique identifier outcome string output field outcome who string output field who who type number type of the resource who techid number unique identifier who initials string output field who initials who colour string output field who colour who imgpath string output field who imgpath who onlinestatus number status value who lastonline string output field who lastonline datetime string time value note string output field note outcome id number unique identifier timetaken number output field timetaken nonbilltime number time value traveltime number time value mileage number output field mileage chargerate number output field chargerate example \[ { "status code" 200, "response headers" { "cache control" "no cache", "transfer encoding" "chunked", "content type" "application/json", "date" "mon, 29 apr 2024 05 54 47 gmt" }, "reason" "ok", "json body" { "ticket id" 0, "record count" 0, "actions" \[] } } ] get agent by id retrieves a specific agent's details from haloitsm using the provided unique identifier endpoint url /api/agent/{{id}} method get input argument name type required description input argument name type required description id number required unique identifier clientidoverride string optional unique identifier get htmldesigner signature boolean optional parameter for get agent by id getholidayallowance boolean optional unique identifier includedetails boolean optional parameter for get agent by id isagentconfig boolean optional parameter for get agent by id loadcache boolean optional parameter for get agent by id output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier name string name of the resource onlinestatus actual number status value onlinestatus number status value useadlogin number output field useadlogin container dn string output field container dn is sales boolean output field is sales warning string output field warning canupdate boolean date value canupdate moreinfo boolean output field canupdate moreinfo example \[ { "status code" 200, "response headers" { "cache control" "no cache", "transfer encoding" "chunked", "content type" "application/json", "date" "mon, 29 apr 2024 05 54 47 gmt" }, "reason" "ok", "json body" { "id" 0, "name" "string", "onlinestatus actual" 0, "onlinestatus" 0, "useadlogin" 0, "container dn" "string", "is sales" true, " warning" "string", " canupdate" true, " canupdate moreinfo" true } } ] get agents retrieves an array of all agents within haloitsm, providing a comprehensive list of available agents endpoint url /api/agent method get input argument name type required description argument name type required description activeinactive string optional parameter for get agents appointmentscreen boolean optional parameter for get agents can edit only boolean optional parameter for get agents client id number optional unique identifier clientidoverride string optional unique identifier department id number optional unique identifier departments string optional parameter for get agents domain string optional parameter for get agents exchangecalendars boolean optional parameter for get agents excludeagent number optional parameter for get agents forcequalmatch boolean optional parameter for get agents includeapiagents boolean optional parameter for get agents includedisabled string optional parameter for get agents includeenabled string optional parameter for get agents includenamedcount boolean optional name of the resource includeroles boolean optional parameter for get agents includestatus boolean optional status value includeunassigned string optional parameter for get agents integration type string optional type of the resource linemanagedonly boolean optional parameter for get agents linkingagents boolean optional parameter for get agents loadcache boolean optional parameter for get agents onlinestatuses string optional status value qualifications string optional parameter for get agents output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 200, "response headers" { "cache control" "no cache", "transfer encoding" "chunked", "content type" "application/json", "date" "mon, 29 apr 2024 05 54 47 gmt" }, "reason" "ok", "json body" \[ {} ] } ] get array of ticket types retrieve a list of available requesttypes from haloitsm to categorize tickets effectively endpoint url /api/tickettype method get input argument name type required description input argument name type required description access control level number optional parameter for get array of ticket types anonanduser boolean optional parameter for get array of ticket types can create only boolean optional parameter for get array of ticket types can edit only boolean optional parameter for get array of ticket types canagentsselect boolean optional parameter for get array of ticket types canusercreate boolean optional parameter for get array of ticket types client id number optional unique identifier domain string optional parameter for get array of ticket types group id number optional unique identifier include current number optional parameter for get array of ticket types include mandatory field check boolean optional parameter for get array of ticket types isquicktimedropdown boolean optional parameter for get array of ticket types itil type number optional type of the resource outcome id number optional unique identifier searchtickets string optional parameter for get array of ticket types showall boolean optional parameter for get array of ticket types showcounts boolean optional parameter for get array of ticket types showinactive boolean optional parameter for get array of ticket types sprints only boolean optional parameter for get array of ticket types ticketarea id number optional unique identifier user only boolean optional parameter for get array of ticket types view id number optional unique identifier output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 200, "response headers" { "cache control" "no cache", "transfer encoding" "chunked", "content type" "application/json", "date" "mon, 29 apr 2024 05 54 47 gmt" }, "reason" "ok", "json body" \[ {} ] } ] get halo site by id retrieves detailed information for a specific haloitsm site using the provided site id endpoint url /api/site/{{id}} method get input argument name type required description input argument name type required description id number required unique identifier client override number optional unique identifier domain string optional parameter for get halo site by id includeactivity boolean optional parameter for get halo site by id includedetails boolean optional parameter for get halo site by id issetup boolean optional parameter for get halo site by id tickettype id number optional unique identifier output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier name string name of the resource client id number unique identifier client name string name of the resource clientsite name string name of the resource inactive boolean output field inactive sla id number unique identifier phonenumber string output field phonenumber example \[ { "status code" 200, "response headers" { "cache control" "no cache", "transfer encoding" "chunked", "content type" "application/json", "date" "mon, 29 apr 2024 05 54 47 gmt" }, "reason" "ok", "json body" { "id" 0, "name" "string", "client id" 0, "client name" "string", "clientsite name" "string", "inactive" true, "sla id" 0, "phonenumber" "string" } } ] get halo sites retrieves an array of site objects from haloitsm, offering a comprehensive overview of all configured sites endpoint url /api/site method get input argument name type required description argument name type required description activeinactive string optional parameter for get halo sites advanced search string optional parameter for get halo sites azuresites boolean optional parameter for get halo sites client id number optional unique identifier contract id number optional unique identifier count number optional count value exclude internal boolean optional parameter for get halo sites gfisites boolean optional parameter for get halo sites idonly boolean optional unique identifier includeactive boolean optional parameter for get halo sites includeaddress boolean optional parameter for get halo sites includeinactive boolean optional parameter for get halo sites includenonstocklocations boolean optional parameter for get halo sites includenoorderstockbin boolean optional parameter for get halo sites includenotes boolean optional parameter for get halo sites includestocklocations boolean optional parameter for get halo sites iscalendarfilter boolean optional parameter for get halo sites item id qty number optional unique identifier item salesorder id number optional unique identifier item salesorder line number optional parameter for get halo sites lastupdatefromdate boolean optional date value lastupdatetodate boolean optional date value order string optional parameter for get halo sites order2 string optional parameter for get halo sites output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase page no number output field page no page size number output field page size record count number count value sites array output field sites id number unique identifier name string name of the resource client id number unique identifier inactive boolean output field inactive phonenumber string output field phonenumber sla id number unique identifier client name string name of the resource colour string output field colour customfields array output field customfields id number unique identifier name string name of the resource label string output field label type number type of the resource value object value for the parameter display string output field display characterlimit number output field characterlimit characterlimittype number type of the resource inputtype number input data for the action example \[ { "status code" 200, "response headers" { "cache control" "no cache", "transfer encoding" "chunked", "content type" "application/json", "date" "mon, 29 apr 2024 05 54 47 gmt" }, "reason" "ok", "json body" { "page no" 0, "page size" 0, "record count" 0, "sites" \[] } } ] get report by id retrieves a specific report from haloitsm using the unique identifier (id) provided endpoint url /api/report/{{id}} method get input argument name type required description input argument name type required description id number required unique identifier client id number optional unique identifier clientname string optional name of the resource dashboard id number optional unique identifier dashboard published id string optional unique identifier dontloadsystemreport boolean optional parameter for get report by id getcompositetoken boolean optional parameter for get report by id includedetails boolean optional parameter for get report by id invoice id number optional unique identifier loadreport boolean optional parameter for get report by id report access token string optional parameter for get report by id reportingperiod number optional parameter for get report by id reportingperiodenddate string optional date value reportingperiodstartdate string optional date value output parameter type description parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier name string name of the resource sql string output field sql reportingperiod number output field reportingperiod availablefields string output field availablefields count boolean count value sqlhasdatefilter boolean output field sqlhasdatefilter usesdynamicsql boolean output field usesdynamicsql available columns array output field available columns id number unique identifier report id number unique identifier name string name of the resource data type string response data data type group string response data sequence number output field sequence filter string output field filter groupbystatus number status value groupbycalc number output field groupbycalc hidden boolean unique identifier orderby number output field orderby orderby desc boolean output field orderby desc warning string output field warning example \[ { "status code" 200, "response headers" { "cache control" "no cache", "transfer encoding" "chunked", "content type" "application/json", "date" "mon, 29 apr 2024 05 54 47 gmt" }, "reason" "ok", "json body" { "id" 0, "name" "string", "sql" "string", "reportingperiod" 0, "availablefields" "string", "count" true, "sqlhasdatefilter" true, "usesdynamicsql" true, "available columns" \[], "columns" \[], "filters" \[], "filterable columns" \[], "permissions agent" \[], "permissions user" \[], "systemreportid" 0 } } ] get reports retrieves a list and count of available report objects from haloitsm, including details for each report endpoint url /api/report method get input argument name type required description input argument name type required description agentrestriction number optional parameter for get reports chartonly boolean optional parameter for get reports clientname string optional name of the resource count number optional count value includepublished boolean optional parameter for get reports order string optional parameter for get reports order2 string optional parameter for get reports order3 string optional parameter for get reports order4 string optional parameter for get reports order5 string optional parameter for get reports orderdesc boolean optional parameter for get reports orderdesc2 boolean optional parameter for get reports orderdesc3 boolean optional parameter for get reports orderdesc4 boolean optional parameter for get reports orderdesc5 boolean optional parameter for get reports page no number optional parameter for get reports page size number optional parameter for get reports pageinate boolean optional parameter for get reports reportgroup id number optional unique identifier search string optional parameter for get reports type number optional type of the resource output parameter type description parameter type description status code number http status code of the response reason string response reason phrase page no number output field page no page size number output field page size record count number count value tickets array output field tickets id number unique identifier dateoccurred string output field dateoccurred summary string output field summary status id number unique identifier tickettype id number unique identifier sla id number unique identifier priority id number unique identifier client id number unique identifier client name string name of the resource site id number unique identifier site name string name of the resource user name string name of the resource team string output field team agent id number unique identifier agent name string name of the resource category 1 string output field category 1 category 2 string output field category 2 category 3 string output field category 3 example \[ { "status code" 200, "response headers" { "cache control" "no cache", "transfer encoding" "chunked", "content type" "application/json", "date" "mon, 29 apr 2024 05 54 47 gmt" }, "reason" "ok", "json body" { "page no" 0, "page size" 0, "record count" 0, "tickets" \[], "columns id" 0, "columns" \[] } } ] get status by id retrieve a specific status object from haloitsm using the unique id provided endpoint url /api/status/{{id}} method get input argument name type required description input argument name type required description id number required unique identifier includedetails boolean optional parameter for get status by id output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier name string name of the resource shortname string name of the resource ticket count number count value statusemailid number unique identifier statusemailfreqdays number status value statusnochangehours number status value notifystatuschange number status value timeuntilloffhold number output field timeuntilloffhold dontsendslareminders boolean output field dontsendslareminders showonquickchange boolean output field showonquickchange statusnochangehoursmanager number status value statusnochangetemplate number status value warning string output field warning type number type of the resource sequence number output field sequence colour string output field colour slaaction string output field slaaction example \[ { "status code" 200, "response headers" { "cache control" "no cache", "transfer encoding" "chunked", "content type" "application/json", "date" "mon, 29 apr 2024 05 54 47 gmt" }, "reason" "ok", "json body" { "id" 0, "name" "string", "shortname" "string", "ticket count" 0, "statusemailid" 0, "statusemailfreqdays" 0, "statusnochangehours" 0, "notifystatuschange" 0, "timeuntilloffhold" 0, "dontsendslareminders" true, "showonquickchange" true, "statusnochangehoursmanager" 0, "statusnochangetemplate" 0, " warning" "string", "type" 0 } } ] get team by id retrieves a specific team from haloitsm using the unique id provided, facilitating targeted data extraction endpoint url /api/team/{{id}} method get input argument name type required description input argument name type required description id number required unique identifier includeagents boolean optional parameter for get team by id includedetails boolean optional parameter for get team by id output parameter type description parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier name string name of the resource sequence number output field sequence forrequests boolean output field forrequests foropps boolean output field foropps forprojects boolean output field forprojects ticket count number count value department id number unique identifier department name string name of the resource inactive boolean output field inactive override column id number unique identifier managers array output field managers id number unique identifier name string name of the resource agent id number unique identifier user id number unique identifier workinghoursbeforealert number output field workinghoursbeforealert emailaddress string output field emailaddress addtoallagents boolean output field addtoallagents allowlivechat boolean output field allowlivechat rtid number unique identifier mailbox override number unique identifier example \[ { "status code" 200, "response headers" { "cache control" "no cache", "transfer encoding" "chunked", "content type" "application/json", "date" "mon, 29 apr 2024 05 54 47 gmt" }, "reason" "ok", "json body" { "id" 0, "name" "string", "sequence" 0, "forrequests" true, "foropps" true, "forprojects" true, "ticket count" 0, "department id" 0, "department name" "string", "inactive" true, "override column id" 0, "managers" \[], "workinghoursbeforealert" 0, "emailaddress" "string", "addtoallagents" true } } ] get team names retrieves an array of team names from haloitsm for use in organizing and categorizing support workflows endpoint url /api/team method get input argument name type required description input argument name type required description can edit only boolean optional parameter for get team names chat only boolean optional parameter for get team names department id number optional unique identifier domain string optional parameter for get team names ids string optional unique identifier include managers boolean optional parameter for get team names includeagentsforteams string optional parameter for get team names includedisabled string optional parameter for get team names includeenabled string optional parameter for get team names istree boolean optional parameter for get team names memberonly boolean optional parameter for get team names mydeps boolean optional parameter for get team names myteamsonly boolean optional parameter for get team names orderbyseq boolean optional parameter for get team names outcome id number optional unique identifier showall boolean optional parameter for get team names showcounts boolean optional parameter for get team names ticketarea id number optional unique identifier type string optional type of the resource view id number optional unique identifier output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 200, "response headers" { "cache control" "no cache", "transfer encoding" "chunked", "content type" "application/json", "date" "mon, 29 apr 2024 05 54 47 gmt" }, "reason" "ok", "json body" \[ {} ] } ] get ticket by id retrieve detailed information for a specific ticket in haloitsm using its unique identifier (id) endpoint url /api/tickets/{{id}} method get input argument name type required description argument name type required description id number required unique identifier amailentryid string optional unique identifier assignedto number optional parameter for get ticket by id consignablelines boolean optional parameter for get ticket by id debug boolean optional parameter for get ticket by id dodatabaselookup boolean optional response data email string optional parameter for get ticket by id include auditing boolean optional parameter for get ticket by id includeagent boolean optional parameter for get ticket by id includechildids boolean optional unique identifier includedetails boolean optional parameter for get ticket by id includelastaction boolean optional parameter for get ticket by id includelastappointment boolean optional parameter for get ticket by id includelinkedobjects boolean optional parameter for get ticket by id includenextappointment boolean optional parameter for get ticket by id includeparentchangeinfo boolean optional parameter for get ticket by id includeparentsubject boolean optional parameter for get ticket by id includeseenby boolean optional parameter for get ticket by id is portal boolean optional parameter for get ticket by id isdetailscreen boolean optional parameter for get ticket by id ishalolink boolean optional parameter for get ticket by id ispreview boolean optional parameter for get ticket by id isteams boolean optional parameter for get ticket by id nocache boolean optional parameter for get ticket by id output parameter type description parameter type description status code number http status code of the response reason string response reason phrase actioncode number output field actioncode id number unique identifier dateoccurred string output field dateoccurred summary string output field summary details string output field details status id number unique identifier tickettype id number unique identifier sla id number unique identifier priority id number unique identifier client id number unique identifier client name string name of the resource site id number unique identifier site name string name of the resource user id number unique identifier user name string name of the resource team string output field team agent id number unique identifier category 1 string output field category 1 category 2 string output field category 2 category 3 string output field category 3 category 4 string output field category 4 estimate number output field estimate example \[ { "status code" 200, "response headers" { "cache control" "no cache", "transfer encoding" "chunked", "content type" "application/json", "date" "mon, 29 apr 2024 05 54 47 gmt" }, "reason" "ok", "json body" { "actioncode" 0, "id" 0, "dateoccurred" "2019 08 02t14 35 55 618z", "summary" "string", "details" "string", "status id" 0, "tickettype id" 0, "sla id" 0, "priority id" 0, "client id" 0, "client name" "string", "site id" 0, "site name" "string", "user id" 0, "user name" "string" } } ] get ticket statuses retrieve all available ticket statuses from the haloitsm system to manage and track support tickets effectively endpoint url /api/status method get input argument name type required description input argument name type required description domain string optional parameter for get ticket statuses excludeclosed boolean optional parameter for get ticket statuses excludepending boolean optional parameter for get ticket statuses outcome id number optional unique identifier showall boolean optional parameter for get ticket statuses showcounts boolean optional parameter for get ticket statuses showquickchangeoptions boolean optional parameter for get ticket statuses split closed boolean optional parameter for get ticket statuses ticket id number optional unique identifier ticket id firstchild number optional unique identifier ticketarea id number optional unique identifier tickettype group id number optional unique identifier tickettype id number optional unique identifier tickettype ids string optional unique identifier type string optional type of the resource view id number optional unique identifier output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 200, "response headers" { "cache control" "no cache", "transfer encoding" "chunked", "content type" "application/json", "date" "mon, 29 apr 2024 05 54 47 gmt" }, "reason" "ok", "json body" \[ {} ] } ] get ticket type by id retrieve a specific ticket type from haloitsm using the unique id provided endpoint url /api/tickettype/{{id}} method get input argument name type required description input argument name type required description id number required unique identifier can create only boolean optional parameter for get ticket type by id can edit only boolean optional parameter for get ticket type by id debug boolean optional parameter for get ticket type by id includeconfig boolean optional parameter for get ticket type by id includedetails boolean optional parameter for get ticket type by id includekbinfo boolean optional parameter for get ticket type by id includeteamrestrictions boolean optional parameter for get ticket type by id isdetailscreen boolean optional parameter for get ticket type by id isnewticket boolean optional parameter for get ticket type by id survey fields boolean optional parameter for get ticket type by id ticket id number optional unique identifier output parameter type description parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier name string name of the resource ticket count number count value visible boolean output field visible enduserscanselect boolean output field enduserscanselect itilrequesttype number type of the resource statusafteruserupdate number status value statusaftersupplierupdate number status value closedrequestswithupdates number output field closedrequestswithupdates includeinmobiledbsync boolean output field includeinmobiledbsync workflow id number unique identifier workflow name string name of the resource always bcc string output field always bcc reopenedstatus number status value closedrequestsemailid number unique identifier webannouncement string output field webannouncement chargerate number output field chargerate initial status number status value default team string output field default team default agent number output field default agent default agent name string name of the resource default sla number output field default sla example \[ { "status code" 200, "response headers" { "cache control" "no cache", "transfer encoding" "chunked", "content type" "application/json", "date" "mon, 29 apr 2024 05 54 47 gmt" }, "reason" "ok", "json body" { "id" 0, "name" "string", "ticket count" 0, "visible" true, "enduserscanselect" true, "itilrequesttype" 0, "statusafteruserupdate" 0, "statusaftersupplierupdate" 0, "closedrequestswithupdates" 0, "includeinmobiledbsync" true, "workflow id" 0, "workflow name" "string", "always bcc" "string", "reopenedstatus" 0, "closedrequestsemailid" 0 } } ] get tickets retrieves a list of current tickets from haloitsm, offering a comprehensive overview without requiring specific input parameters endpoint url /api/tickets method get input argument name type required description argument name type required description advanced search string optional parameter for get tickets agent array optional parameter for get tickets agent id number optional unique identifier alerttype string optional type of the resource asset id number optional unique identifier awaitinginput string optional input data for the action billableonly boolean optional parameter for get tickets billing date string optional date value billing type string optional type of the resource billingcontractid number optional unique identifier calendar enddate string optional date value calendar startdate string optional date value category 1 array optional parameter for get tickets category 2 array optional parameter for get tickets category 3 array optional parameter for get tickets category 4 array optional parameter for get tickets checkmyticketsonly boolean optional parameter for get tickets client id number optional unique identifier client ids array optional unique identifier client ref string optional parameter for get tickets closed only boolean optional parameter for get tickets columns id number optional unique identifier contract id number optional unique identifier contract period number optional parameter for get tickets output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 200, "response headers" { "cache control" "no cache", "transfer encoding" "chunked", "content type" "application/json", "date" "mon, 29 apr 2024 05 54 47 gmt" }, "reason" "ok", "json body" {} } ] post ticket type adds or updates haloitsm ticket types, creating a new type if no id exists or updating an existing one endpoint url /api/tickettype method post input argument name type required description argument name type required description id number optional unique identifier name string optional name of the resource ticket count number optional count value visible boolean optional parameter for post ticket type enduserscanselect boolean optional parameter for post ticket type itilrequesttype number optional type of the resource statusafteruserupdate number optional status value statusaftersupplierupdate number optional status value closedrequestswithupdates number optional parameter for post ticket type includeinmobiledbsync boolean optional parameter for post ticket type workflow id number optional unique identifier workflow name string optional name of the resource always bcc string optional parameter for post ticket type reopenedstatus number optional status value closedrequestsemailid number optional unique identifier webannouncement string optional parameter for post ticket type chargerate number optional parameter for post ticket type initial status number optional status value default team string optional parameter for post ticket type default agent number optional parameter for post ticket type default agent name string optional name of the resource default sla number optional parameter for post ticket type default priority number optional parameter for post ticket type default category 1 string optional parameter for post ticket type output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase success boolean whether the operation was successful example \[ { "status code" 200, "response headers" { "cache control" "no cache", "transfer encoding" "chunked", "content type" "application/json", "date" "mon, 29 apr 2024 05 54 47 gmt" }, "reason" "ok", "json body" { "success" true } } ] retrieve client by id retrieve a specific client object from haloitsm using the unique identifier (id) provided in the path parameters endpoint url /api/client/{{id}} method get input argument name type required description input argument name type required description id number required unique identifier domain string optional parameter for retrieve client by id getavailablerts boolean optional parameter for retrieve client by id includeactivity boolean optional parameter for retrieve client by id includedetails boolean optional parameter for retrieve client by id includeperiods boolean optional parameter for retrieve client by id includeprepay boolean optional parameter for retrieve client by id tickettype id number optional unique identifier output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier name string name of the resource toplevel id number unique identifier toplevel name string name of the resource inactive boolean output field inactive colour string output field colour confirmemail number output field confirmemail actionemail number output field actionemail clearemail number output field clearemail messagegroup id number unique identifier from address override string unique identifier logo string output field logo warning string output field warning example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "id" 0, "name" "string", "toplevel id" 0, "toplevel name" "string", "inactive" true, "colour" "string", "confirmemail" 0, "actionemail" 0, "clearemail" 0, "messagegroup id" 0, "from address override" "string", "logo" "string", " warning" "string" } } ] retrieve client records retrieves a list of all client records and their count from haloitsm, providing an overview of client data endpoint url /api/client method get input argument name type required description argument name type required description accountmanageronly boolean optional parameter for retrieve client records activeinactive string optional parameter for retrieve client records advanced search string optional parameter for retrieve client records azureclients boolean optional parameter for retrieve client records callplan boolean optional parameter for retrieve client records columns id number optional unique identifier count number optional count value domain string optional parameter for retrieve client records exclude internal boolean optional parameter for retrieve client records gficlients boolean optional parameter for retrieve client records idonly boolean optional unique identifier includeactive boolean optional parameter for retrieve client records includeazuretenants boolean optional parameter for retrieve client records includecolumns boolean optional parameter for retrieve client records includeinactive boolean optional parameter for retrieve client records includeinvoicetemplatename boolean optional name of the resource includenotes boolean optional parameter for retrieve client records includeqbofields boolean optional parameter for retrieve client records integration tenantids array optional unique identifier integration type string optional type of the resource isjira boolean optional parameter for retrieve client records issentinel boolean optional parameter for retrieve client records isservicenow boolean optional parameter for retrieve client records lastupdatefromdate boolean optional date value output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase page no number output field page no page size number output field page size record count number count value clients array output field clients id number unique identifier name string name of the resource colour string output field colour inactive boolean output field inactive toplevel id number unique identifier toplevel name string name of the resource customfields array output field customfields id number unique identifier name string name of the resource label string output field label type number type of the resource value object value for the parameter display string output field display characterlimit number output field characterlimit characterlimittype number type of the resource inputtype number input data for the action example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "page no" 0, "page size" 0, "record count" 0, "clients" \[] } } ] retrieve halo user by id retrieves a haloitsm user's details using their unique identifier (id) provided in the path parameters endpoint url /api/users/{{id}} method get input argument name type required description input argument name type required description id number required unique identifier client id number optional unique identifier client override number optional unique identifier domain string optional parameter for retrieve halo user by id includeactivity boolean optional parameter for retrieve halo user by id includebillinginfo boolean optional parameter for retrieve halo user by id includedetails boolean optional parameter for retrieve halo user by id includepopups boolean optional parameter for retrieve halo user by id includeusersassets boolean optional parameter for retrieve halo user by id issetup boolean optional parameter for retrieve halo user by id opp id number optional unique identifier site id number optional unique identifier site override number optional unique identifier supplier id number optional unique identifier tickettype id number optional unique identifier username string optional name of the resource output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier name string name of the resource site id number unique identifier site name string name of the resource client name string name of the resource firstname string name of the resource surname string name of the resource initials string output field initials title string output field title warning string output field warning client id number unique identifier example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "id" 0, "name" "string", "site id" 0, "site name" "string", "client name" "string", "firstname" "string", "surname" "string", "initials" "string", "title" "string", " warning" "string", "client id" 0 } } ] retrieve halo users retrieves user details from haloitsm, including a count and an array of user objects for user management overview endpoint url /api/users method get input argument name type required description argument name type required description activeinactive string optional parameter for retrieve halo users advanced search string optional parameter for retrieve halo users allapprovers boolean optional parameter for retrieve halo users approvers only boolean optional parameter for retrieve halo users asset id number optional unique identifier client id number optional unique identifier contract id number optional unique identifier count number optional count value department id number optional unique identifier exclude agents boolean optional parameter for retrieve halo users exclude defaultsiteusers boolean optional parameter for retrieve halo users exclude generaluser boolean optional parameter for retrieve halo users idonly boolean optional unique identifier includeactive boolean optional parameter for retrieve halo users includebillinginfo boolean optional parameter for retrieve halo users includeinactive boolean optional parameter for retrieve halo users includename boolean optional name of the resource includenonserviceaccount boolean optional count value includenotes boolean optional parameter for retrieve halo users includeserviceaccount boolean optional count value integration type string optional type of the resource is followers boolean optional parameter for retrieve halo users is3cxcall boolean optional parameter for retrieve halo users lastupdatefromdate boolean optional date value output parameter type description parameter type description status code number http status code of the response reason string response reason phrase page no number output field page no page size number output field page size record count number count value users array output field users id number unique identifier name string name of the resource site name string name of the resource actived string output field actived emailaddress string output field emailaddress phonenumber string output field phonenumber fax string output field fax firstname string name of the resource inactive boolean output field inactive surname string name of the resource login string output field login mobilenumber string output field mobilenumber mobilenumber2 string output field mobilenumber2 site id number unique identifier homenumber string output field homenumber telpref number output field telpref title string output field title client id number unique identifier example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "page no" 0, "page size" 0, "record count" 0, "users" \[] } } ] update actions adds or updates an action in haloitsm using the mandatory 'ticket id' endpoint url /api/actions method post input argument name type required description argument name type required description note html string optional parameter for update actions ticket id number optional unique identifier id number optional unique identifier outcome string optional parameter for update actions who string optional parameter for update actions who type number optional type of the resource who imgpath string optional parameter for update actions who agentid number optional unique identifier datetime string optional time value note string optional parameter for update actions emailbody string optional request body data emailsubject string optional parameter for update actions emailbody html string optional request body data actionuserdef number optional parameter for update actions userdesc string optional parameter for update actions actiondatecreated string optional parameter for update actions actioninvoicenumber string optional parameter for update actions externalinvoicenumber number optional parameter for update actions actionchargeamount number optional parameter for update actions actionchargehours number optional parameter for update actions actionnonchargeamount number optional parameter for update actions actionnonchargehours number optional parameter for update actions actioncontractid number optional unique identifier actprocessid number optional unique identifier output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase success boolean whether the operation was successful example \[ { "status code" 200, "response headers" { "cache control" "no cache", "transfer encoding" "chunked", "content type" "application/json", "date" "mon, 29 apr 2024 05 54 47 gmt" }, "reason" "ok", "json body" { "success" true } } ] update halo site adds or updates a site in haloitsm, determining the action based on the presence of a site id endpoint url /api/site method post input argument name type required description argument name type required description id number optional unique identifier name string optional name of the resource client id number optional unique identifier client name string optional name of the resource clientsite name string optional name of the resource inactive boolean optional parameter for update halo site sla id number optional unique identifier phonenumber string optional parameter for update halo site colour string optional parameter for update halo site timezone string optional parameter for update halo site invoice address isdelivery boolean optional parameter for update halo site datecreated string optional parameter for update halo site text number optional parameter for update halo site globx number optional parameter for update halo site globy number optional parameter for update halo site style number optional parameter for update halo site inuseby number optional parameter for update halo site notes string optional parameter for update halo site upwho number optional parameter for update halo site uptimestamp string optional parameter for update halo site xrefsite number optional parameter for update halo site zoffsetx number optional parameter for update halo site zoffsety number optional parameter for update halo site zoomx number optional parameter for update halo site output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase success boolean whether the operation was successful example \[ { "status code" 200, "response headers" { "cache control" "no cache", "transfer encoding" "chunked", "content type" "application/json", "date" "mon, 29 apr 2024 05 54 47 gmt" }, "reason" "ok", "json body" { "success" true } } ] update halo users adds or updates haloitsm users, modifying existing entries with an id or creating new ones when no id is present endpoint url /api/users method post input argument name type required description argument name type required description id number optional unique identifier name string optional name of the resource site id number optional unique identifier site name string optional name of the resource client name string optional name of the resource firstname string optional name of the resource surname string optional name of the resource initials string optional parameter for update halo users title string optional parameter for update halo users emailaddress string optional parameter for update halo users phonenumber preferred string optional parameter for update halo users sitephonenumber string optional parameter for update halo users phonenumber string optional parameter for update halo users homenumber string optional parameter for update halo users mobilenumber string optional parameter for update halo users mobilenumber2 string optional parameter for update halo users fax string optional parameter for update halo users telpref number optional parameter for update halo users activedirectory dn string optional parameter for update halo users container dn string optional parameter for update halo users login string optional parameter for update halo users inactive boolean optional parameter for update halo users colour string optional parameter for update halo users isimportantcontact boolean optional parameter for update halo users output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase success boolean whether the operation was successful example \[ { "status code" 200, "response headers" { "cache control" "no cache", "transfer encoding" "chunked", "content type" "application/json", "date" "mon, 29 apr 2024 05 54 47 gmt" }, "reason" "ok", "json body" { "success" true } } ] update report adds or updates a report within haloitsm, determined by the presence of a unique identifier endpoint url /api/report method post input argument name type required description argument name type required description id number optional unique identifier name string optional name of the resource sql string optional parameter for update report reportingperiod number optional parameter for update report availablefields string optional parameter for update report selectedfields string optional parameter for update report reportingperiodstartdate string optional date value reportingperiodenddate string optional date value reportingperioddatefield string optional parameter for update report sqlid number optional unique identifier charttitle string optional parameter for update report xaxis string optional parameter for update report yaxis string optional parameter for update report xaxiscaption string optional parameter for update report yaxiscaption string optional parameter for update report graphorderby string optional parameter for update report charttype number optional type of the resource graphorder number optional parameter for update report count boolean optional count value sum boolean optional parameter for update report showgraphvalues boolean optional value for the parameter client string optional parameter for update report builtinid boolean optional unique identifier seriestype1 number optional type of the resource output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase success boolean whether the operation was successful example \[ { "status code" 200, "response headers" { "cache control" "no cache", "transfer encoding" "chunked", "content type" "application/json", "date" "mon, 29 apr 2024 05 54 47 gmt" }, "reason" "ok", "json body" { "success" true } } ] update team adds or updates a team in haloitsm, with the operation depending on the presence of an id parameter endpoint url /api/team method post input argument name type required description argument name type required description id number optional unique identifier name string optional name of the resource sequence number optional parameter for update team forrequests boolean optional parameter for update team foropps boolean optional parameter for update team forprojects boolean optional parameter for update team ticket count number optional count value department id number optional unique identifier department name string optional name of the resource inactive boolean optional parameter for update team override column id number optional unique identifier managers array optional parameter for update team id number optional unique identifier name string optional name of the resource agent id number optional unique identifier user id number optional unique identifier workinghoursbeforealert number optional parameter for update team emailaddress string optional parameter for update team addtoallagents boolean optional parameter for update team allowlivechat boolean optional parameter for update team rtid number optional unique identifier mailbox override number optional unique identifier agents array optional parameter for update team id number optional unique identifier output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase success boolean whether the operation was successful example \[ { "status code" 200, "response headers" { "cache control" "no cache", "transfer encoding" "chunked", "content type" "application/json", "date" "mon, 29 apr 2024 05 54 47 gmt" }, "reason" "ok", "json body" { "success" true } } ] update ticket adds or updates a ticket in haloitsm, determining the action based on the presence of a ticket id endpoint url /api/tickets method post input argument name type required description argument name type required description actioncode number optional parameter for update ticket id number optional unique identifier dateoccurred string optional parameter for update ticket summary string optional parameter for update ticket details string optional parameter for update ticket status id number optional unique identifier tickettype id number optional unique identifier sla id number optional unique identifier priority id number optional unique identifier client id number optional unique identifier client name string optional name of the resource site id number optional unique identifier site name string optional name of the resource user id number optional unique identifier user name string optional name of the resource team string optional parameter for update ticket agent id number optional unique identifier category 1 string optional parameter for update ticket category 2 string optional parameter for update ticket category 3 string optional parameter for update ticket category 4 string optional parameter for update ticket estimate number optional parameter for update ticket timetaken number optional parameter for update ticket supplier name string optional name of the resource output parameter type description output parameter type description status code number http status code of the response reason string response reason phrase success boolean whether the operation was successful example \[ { "status code" 201, "response headers" { "cache control" "no cache", "transfer encoding" "chunked", "content type" "application/json", "date" "mon, 29 apr 2024 05 54 47 gmt" }, "reason" "ok", "json body" { "success" true } } ] response headers header description example cache control directives for caching mechanisms no cache connection http response header connection keep alive content length the length of the response body in bytes 16093 content type the media type of the resource application/json date the date and time at which the message was originated wed, 19 jun 2024 07 06 15 gmt request context http response header request context appid=cid v1 \ a16f5763 e566 48d2 8ad2 e172951888ad server information about the software used by the origin server strict transport security http response header strict transport security max age=31536000; includesubdomains; preload transfer encoding http response header transfer encoding chunked x content type options http response header x content type options nosniff notes please check the following details regarding the permissions and use them wherever applicable list of permissions required for accessing reports related actions https //halo haloservicedesk com/apidoc/resources/reportslist of permissions required for accessing halo sites related actions https //halo haloservicedesk com/apidoc/resources/siteslist of permissions required for accessing status related actions https //halo haloservicedesk com/apidoc/resources/statuslist of permissions required for accessing teams related actions https //halo haloservicedesk com/apidoc/resources/teamslist of permissions required for accessing ticket types related actions https //halo haloservicedesk com/apidoc/resources/tickettypelist of permissions required for accessing tickets related actions https //halo haloservicedesk com/apidoc/resources/ticketslist of permissions required for accessing users related actions https //halo haloservicedesk com/apidoc/resources/userslist of permissions required for accessing agents related actions https //halo haloservicedesk com/apidoc/resources/agentslist of permissions required for accessing actions related actions https //halo haloservicedesk com/apidoc/resources/actionslist of permissions required for accessing client related actions https //halo haloservicedesk com/apidoc/resources/clientslist of permissions required for accessing attachments related actions https //halo haloservicedesk com/apidoc/resources/attachments