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
Notes
Please check the following details regarding the permissions and use them wherever applicable.
API Documentation Link
- For more information on HaloITSM is found at: HaloITSM API Documentation
Additional Documentation
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
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output 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 |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Get Action by ID action |
parameters.agentonly | boolean | Optional | Parameters for the Get Action by ID action |
parameters.emailonly | boolean | Optional | Parameters for the Get Action by ID action |
parameters.includedetails | boolean | Optional | Parameters for the Get Action by ID action |
parameters.includeemail | boolean | Optional | Parameters for the Get Action by ID action |
parameters.mostrecent | boolean | Optional | Parameters for the Get Action by ID action |
parameters.nonsystem | boolean | Optional | Parameters for the Get Action by ID action |
parameters.penultimate | boolean | Optional | Parameters for the Get Action by ID action |
parameters.ticket_id | number | Optional | Parameters for the Get Action by ID action |
Input Example
{"parameters":{"agentonly":false,"emailonly":false,"includedetails":false,"includeemail":false,"mostrecent":false,"nonsystem":false,"penultimate":false,"ticket_id":0},"path_parameters":{"id":4518}}
Output
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 |
actioncontractid | number | Unique identifier |
Output 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 |
|---|---|---|---|
parameters.actoutcome | string | Optional | Parameters for the Get Actions action |
parameters.actoutcomenum | number | Optional | Parameters for the Get Actions action |
parameters.agentonly | boolean | Optional | Parameters for the Get Actions action |
parameters.conversationonly | boolean | Optional | Parameters for the Get Actions action |
parameters.count | number | Optional | Parameters for the Get Actions action |
parameters.datesearch | string | Optional | Parameters for the Get Actions action |
parameters.enddate | string | Optional | Parameters for the Get Actions action |
parameters.excludebilling | boolean | Optional | Parameters for the Get Actions action |
parameters.excludehiddenfrominternalit | boolean | Optional | Parameters for the Get Actions action |
parameters.excludeprivate | boolean | Optional | Parameters for the Get Actions action |
parameters.excludesys | boolean | Optional | Parameters for the Get Actions action |
parameters.importantonly | boolean | Optional | Parameters for the Get Actions action |
parameters.importanttop | boolean | Optional | Parameters for the Get Actions action |
parameters.includeagentdetails | boolean | Optional | Parameters for the Get Actions action |
parameters.includeattachments | boolean | Optional | Parameters for the Get Actions action |
parameters.includefacebookfields | boolean | Optional | Parameters for the Get Actions action |
parameters.includehtmlemail | boolean | Optional | Parameters for the Get Actions action |
parameters.includehtmlnote | boolean | Optional | Parameters for the Get Actions action |
parameters.includenonactionattachments | boolean | Optional | Parameters for the Get Actions action |
parameters.includetranslations | boolean | Optional | Parameters for the Get Actions action |
parameters.includetwitterfields | boolean | Optional | Parameters for the Get Actions action |
parameters.intraticketonly | boolean | Optional | Parameters for the Get Actions action |
parameters.ischildnotes | boolean | Optional | Parameters for the Get Actions action |
parameters.isrelatednotes | boolean | Optional | Parameters for the Get Actions action |
parameters.slaonly | boolean | Optional | Parameters for the Get Actions action |
Input Example
{"parameters":{"actoutcome":"","actoutcomenum":0,"agentonly":false,"conversationonly":false,"count":0,"datesearch":"","enddate":"","excludebilling":false,"excludehiddenfrominternalit":false,"excludeprivate":false,"excludesys":false,"importantonly":false,"importanttop":false,"includeagentdetails":false,"includeattachments":false,"includefacebookfields":false,"includehtmlemail":false,"includehtmlnote":false,"includenonactionattachments":false,"includetranslations":false,"includetwitterfields":false,"intraticketonly":false,"ischildnotes":false,"isrelatednotes":false,"slaonly":false,"startdate":"","supplieronly":false,"ticket_id":0,"timeentriesonly":false}}
Output
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 |
actions.ticket_id | number | Unique identifier |
actions.id | number | Unique identifier |
actions.outcome | string | Output field: actions.outcome |
actions.who | string | Output field: actions.who |
actions.who_type | number | Type of the resource |
actions.who_techid | number | Unique identifier |
actions.who_initials | string | Output field: actions.who_initials |
actions.who_colour | string | Output field: actions.who_colour |
actions.who_imgpath | string | Output field: actions.who_imgpath |
actions.who_onlinestatus | number | Status value |
actions.who_lastonline | string | Output field: actions.who_lastonline |
actions.datetime | string | Time value |
actions.note | string | Output field: actions.note |
actions.outcome_id | number | Unique identifier |
actions.timetaken | number | Output field: actions.timetaken |
actions.nonbilltime | number | Time value |
actions.traveltime | number | Time value |
actions.mileage | number | Output field: actions.mileage |
actions.chargerate | number | Output field: actions.chargerate |
actions.hiddenfromuser | boolean | Unique identifier |
Output 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 |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Get Agent by ID action |
parameters.clientidoverride | string | Optional | Parameters for the Get Agent by ID action |
parameters.get_htmldesigner_signature | boolean | Optional | Parameters for the Get Agent by ID action |
parameters.getholidayallowance | boolean | Optional | Parameters for the Get Agent by ID action |
parameters.includedetails | boolean | Optional | Parameters for the Get Agent by ID action |
parameters.isagentconfig | boolean | Optional | Parameters for the Get Agent by ID action |
parameters.loadcache | boolean | Optional | Parameters for the Get Agent by ID action |
Input Example
{"parameters":{"clientidoverride":"","get_htmldesigner_signature":true,"getholidayallowance":true,"includedetails":true,"isagentconfig":true,"loadcache":true},"path_parameters":{"id":4518}}
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 |
Output 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 |
|---|---|---|---|
parameters.activeinactive | string | Optional | Parameters for the Get Agents action |
parameters.appointmentscreen | boolean | Optional | Parameters for the Get Agents action |
parameters.can_edit_only | boolean | Optional | Parameters for the Get Agents action |
parameters.client_id | number | Optional | Parameters for the Get Agents action |
parameters.clientidoverride | string | Optional | Parameters for the Get Agents action |
parameters.department_id | number | Optional | Parameters for the Get Agents action |
parameters.departments | string | Optional | Parameters for the Get Agents action |
parameters.domain | string | Optional | Parameters for the Get Agents action |
parameters.exchangecalendars | boolean | Optional | Parameters for the Get Agents action |
parameters.excludeAgent | number | Optional | Parameters for the Get Agents action |
parameters.forcequalmatch | boolean | Optional | Parameters for the Get Agents action |
parameters.includeapiagents | boolean | Optional | Parameters for the Get Agents action |
parameters.includedisabled | string | Optional | Parameters for the Get Agents action |
parameters.includeenabled | string | Optional | Parameters for the Get Agents action |
parameters.includenamedcount | boolean | Optional | Parameters for the Get Agents action |
parameters.includeroles | boolean | Optional | Parameters for the Get Agents action |
parameters.includestatus | boolean | Optional | Parameters for the Get Agents action |
parameters.includeunassigned | string | Optional | Parameters for the Get Agents action |
parameters.integration_type | string | Optional | Parameters for the Get Agents action |
parameters.linemanagedonly | boolean | Optional | Parameters for the Get Agents action |
parameters.linkingagents | boolean | Optional | Parameters for the Get Agents action |
parameters.loadcache | boolean | Optional | Parameters for the Get Agents action |
parameters.onlinestatuses | string | Optional | Parameters for the Get Agents action |
parameters.qualifications | string | Optional | Parameters for the Get Agents action |
parameters.reassign | boolean | Optional | Parameters for the Get Agents action |
Input Example
{"parameters":{"activeinactive":"","appointmentscreen":false,"can_edit_only":false,"client_id":0,"clientidoverride":"","department_id":0,"departments":"","domain":"","exchangecalendars":false,"excludeAgent":0,"forcequalmatch":false,"includeapiagents":false,"includedisabled":"","includeenabled":"","includenamedcount":false,"includeroles":false,"includestatus":false,"includeunassigned":"","integration_type":"","linemanagedonly":false,"linkingagents":false,"loadcache":false,"onlinestatuses":"","qualifications":"","reassign":false,"remoteagents":false,"remoteagenttype":"","role":"","search":"","shiftagentsonly":false,"showall":false,"showcounts":false,"team":"","team_id":0,"teams":"","thisAgentOnly":false,"ticketarea_id":0,"tickettype_id":0,"view_id":0,"withemail":false}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output 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":0,"lastonline":"string","team":"string","isdisabled":true,"email":"string","ad":"string","lastlogindate":"2017-11-01T16:03:33.030Z","agentphotopath":"string","initials":"string","firstname":"string","surname":"string","colour":"string","ticket_count":0}]}
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 |
|---|---|---|---|
parameters.access_control_level | number | Optional | Parameters for the Get Array of Ticket Types action |
parameters.anonanduser | boolean | Optional | Parameters for the Get Array of Ticket Types action |
parameters.can_create_only | boolean | Optional | Parameters for the Get Array of Ticket Types action |
parameters.can_edit_only | boolean | Optional | Parameters for the Get Array of Ticket Types action |
parameters.canagentsselect | boolean | Optional | Parameters for the Get Array of Ticket Types action |
parameters.canusercreate | boolean | Optional | Parameters for the Get Array of Ticket Types action |
parameters.client_id | number | Optional | Parameters for the Get Array of Ticket Types action |
parameters.domain | string | Optional | Parameters for the Get Array of Ticket Types action |
parameters.group_id | number | Optional | Parameters for the Get Array of Ticket Types action |
parameters.include_current | number | Optional | Parameters for the Get Array of Ticket Types action |
parameters.include_mandatory_field_check | boolean | Optional | Parameters for the Get Array of Ticket Types action |
parameters.isquicktimedropdown | boolean | Optional | Parameters for the Get Array of Ticket Types action |
parameters.itil_type | number | Optional | Parameters for the Get Array of Ticket Types action |
parameters.outcome_id | number | Optional | Parameters for the Get Array of Ticket Types action |
parameters.searchtickets | string | Optional | Parameters for the Get Array of Ticket Types action |
parameters.showall | boolean | Optional | Parameters for the Get Array of Ticket Types action |
parameters.showcounts | boolean | Optional | Parameters for the Get Array of Ticket Types action |
parameters.showinactive | boolean | Optional | Parameters for the Get Array of Ticket Types action |
parameters.sprints_only | boolean | Optional | Parameters for the Get Array of Ticket Types action |
parameters.ticketarea_id | number | Optional | Parameters for the Get Array of Ticket Types action |
parameters.user_only | boolean | Optional | Parameters for the Get Array of Ticket Types action |
parameters.view_id | number | Optional | Parameters for the Get Array of Ticket Types action |
Input Example
{"parameters":{"access_control_level":0,"anonanduser":true,"can_create_only":true,"can_edit_only":true,"canagentsselect":true,"canusercreate":true,"client_id":0,"domain":"","group_id":0,"include_current":0,"include_mandatory_field_check":true,"isquicktimedropdown":true,"itil_type":0,"outcome_id":0,"searchtickets":"","showall":true,"showcounts":true,"showinactive":true,"sprints_only":true,"ticketarea_id":0,"user_only":true,"view_id":0}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output 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,"use":"string","sequence":0}]}
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 |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Get Halo Site by ID action |
parameters.client_override | number | Optional | Parameters for the Get Halo Site by ID action |
parameters.domain | string | Optional | Parameters for the Get Halo Site by ID action |
parameters.includeactivity | boolean | Optional | Parameters for the Get Halo Site by ID action |
parameters.includedetails | boolean | Optional | Parameters for the Get Halo Site by ID action |
parameters.issetup | boolean | Optional | Parameters for the Get Halo Site by ID action |
parameters.tickettype_id | number | Optional | Parameters for the Get Halo Site by ID action |
Input Example
{"parameters":{"client_override":0,"domain":"","includeactivity":false,"includedetails":false,"issetup":false,"tickettype_id":0},"path_parameters":{"id":4518}}
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 |
Output 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 |
|---|---|---|---|
parameters.activeinactive | string | Optional | Parameters for the Get Halo Sites action |
parameters.advanced_search | string | Optional | Parameters for the Get Halo Sites action |
parameters.azuresites | boolean | Optional | Parameters for the Get Halo Sites action |
parameters.client_id | number | Optional | Parameters for the Get Halo Sites action |
parameters.contract_id | number | Optional | Parameters for the Get Halo Sites action |
parameters.count | number | Optional | Parameters for the Get Halo Sites action |
parameters.exclude_internal | boolean | Optional | Parameters for the Get Halo Sites action |
parameters.gfisites | boolean | Optional | Parameters for the Get Halo Sites action |
parameters.idonly | boolean | Optional | Parameters for the Get Halo Sites action |
parameters.includeactive | boolean | Optional | Parameters for the Get Halo Sites action |
parameters.includeaddress | boolean | Optional | Parameters for the Get Halo Sites action |
parameters.includeinactive | boolean | Optional | Parameters for the Get Halo Sites action |
parameters.includenonstocklocations | boolean | Optional | Parameters for the Get Halo Sites action |
parameters.includenoorderstockbin | boolean | Optional | Parameters for the Get Halo Sites action |
parameters.includenotes | boolean | Optional | Parameters for the Get Halo Sites action |
parameters.includestocklocations | boolean | Optional | Parameters for the Get Halo Sites action |
parameters.iscalendarfilter | boolean | Optional | Parameters for the Get Halo Sites action |
parameters.item_id_qty | number | Optional | Parameters for the Get Halo Sites action |
parameters.item_salesorder_id | number | Optional | Parameters for the Get Halo Sites action |
parameters.item_salesorder_line | number | Optional | Parameters for the Get Halo Sites action |
parameters.lastupdatefromdate | boolean | Optional | Parameters for the Get Halo Sites action |
parameters.lastupdatetodate | boolean | Optional | Parameters for the Get Halo Sites action |
parameters.order | string | Optional | Parameters for the Get Halo Sites action |
parameters.order2 | string | Optional | Parameters for the Get Halo Sites action |
parameters.order3 | string | Optional | Parameters for the Get Halo Sites action |
Input Example
{"parameters":{"activeinactive":"","advanced_search":"","azuresites":false,"client_id":0,"contract_id":0,"count":0,"exclude_internal":false,"gfisites":false,"idonly":false,"includeactive":false,"includeaddress":false,"includeinactive":false,"includenonstocklocations":false,"includenoorderstockbin":false,"includenotes":false,"includestocklocations":false,"iscalendarfilter":false,"item_id_qty":0,"item_salesorder_id":0,"item_salesorder_line":0,"lastupdatefromdate":false,"lastupdatetodate":false,"order":"","order2":"","order3":"","order4":"","order5":"","orderdesc":false,"orderdesc2":false,"orderdesc3":false,"orderdesc4":false,"orderdesc5":false,"override_enablestockbins":false,"page_no":0,"page_size":0,"pageinate":false,"search":"","site_id":0,"sitefields":"","stocklocation":"","toplevel_id":0,"user_override":0}}
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 |
sites.id | number | Unique identifier |
sites.name | string | Name of the resource |
sites.client_id | number | Unique identifier |
sites.inactive | boolean | Output field: sites.inactive |
sites.phonenumber | string | Output field: sites.phonenumber |
sites.sla_id | number | Unique identifier |
sites.client_name | string | Name of the resource |
sites.colour | string | Output field: sites.colour |
sites.customfields | array | Output field: sites.customfields |
sites.customfields.id | number | Unique identifier |
sites.customfields.name | string | Name of the resource |
sites.customfields.label | string | Output field: sites.customfields.label |
sites.customfields.type | number | Type of the resource |
sites.customfields.value | object | Value for the parameter |
sites.customfields.display | string | Output field: sites.customfields.display |
sites.customfields.characterlimit | number | Output field: sites.customfields.characterlimit |
sites.customfields.characterlimittype | number | Type of the resource |
sites.customfields.inputtype | number | Input data for the action |
Output 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 |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Get Report by ID action |
parameters.client_id | number | Optional | Parameters for the Get Report by ID action |
parameters.clientname | string | Optional | Parameters for the Get Report by ID action |
parameters.dashboard_id | number | Optional | Parameters for the Get Report by ID action |
parameters.dashboard_published_id | string | Optional | Parameters for the Get Report by ID action |
parameters.dontloadsystemreport | boolean | Optional | Parameters for the Get Report by ID action |
parameters.getcompositetoken | boolean | Optional | Parameters for the Get Report by ID action |
parameters.includedetails | boolean | Optional | Parameters for the Get Report by ID action |
parameters.invoice_id | number | Optional | Parameters for the Get Report by ID action |
parameters.loadreport | boolean | Optional | Parameters for the Get Report by ID action |
parameters.report_access_token | string | Optional | Parameters for the Get Report by ID action |
parameters.reportingperiod | number | Optional | Parameters for the Get Report by ID action |
parameters.reportingperiodenddate | string | Optional | Parameters for the Get Report by ID action |
parameters.reportingperiodstartdate | string | Optional | Parameters for the Get Report by ID action |
Input Example
{"parameters":{"client_id":0,"clientname":"","dashboard_id":0,"dashboard_published_id":"","dontloadsystemreport":false,"getcompositetoken":false,"includedetails":false,"invoice_id":0,"loadreport":false,"report_access_token":"","reportingperiod":0,"reportingperiodenddate":"","reportingperiodstartdate":""},"path_parameters":{"id":4518}}
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 |
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 |
available_columns.id | number | Unique identifier |
available_columns.report_id | number | Unique identifier |
available_columns.name | string | Name of the resource |
available_columns.data_type | string | Response data |
available_columns.data_type_group | string | Response data |
available_columns.sequence | number | Output field: available_columns.sequence |
available_columns.filter | string | Output field: available_columns.filter |
available_columns.groupbystatus | number | Status value |
available_columns.groupbycalc | number | Output field: available_columns.groupbycalc |
available_columns.hidden | boolean | Unique identifier |
available_columns.orderby | number | Output field: available_columns.orderby |
available_columns.orderby_desc | boolean | Output field: available_columns.orderby_desc |
available_columns._warning | string | Output field: available_columns._warning |
columns | array | Output field: columns |
Output 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 |
|---|---|---|---|
parameters.agentrestriction | number | Optional | Parameters for the Get Reports action |
parameters.chartonly | boolean | Optional | Parameters for the Get Reports action |
parameters.clientname | string | Optional | Parameters for the Get Reports action |
parameters.count | number | Optional | Parameters for the Get Reports action |
parameters.includepublished | boolean | Optional | Parameters for the Get Reports action |
parameters.order | string | Optional | Parameters for the Get Reports action |
parameters.order2 | string | Optional | Parameters for the Get Reports action |
parameters.order3 | string | Optional | Parameters for the Get Reports action |
parameters.order4 | string | Optional | Parameters for the Get Reports action |
parameters.order5 | string | Optional | Parameters for the Get Reports action |
parameters.orderdesc | boolean | Optional | Parameters for the Get Reports action |
parameters.orderdesc2 | boolean | Optional | Parameters for the Get Reports action |
parameters.orderdesc3 | boolean | Optional | Parameters for the Get Reports action |
parameters.orderdesc4 | boolean | Optional | Parameters for the Get Reports action |
parameters.orderdesc5 | boolean | Optional | Parameters for the Get Reports action |
parameters.page_no | number | Optional | Parameters for the Get Reports action |
parameters.page_size | number | Optional | Parameters for the Get Reports action |
parameters.pageinate | boolean | Optional | Parameters for the Get Reports action |
parameters.reportgroup_id | number | Optional | Parameters for the Get Reports action |
parameters.search | string | Optional | Parameters for the Get Reports action |
parameters.type | number | Optional | Parameters for the Get Reports action |
Input Example
{"parameters":{"agentrestriction":0,"chartonly":false,"clientname":"","count":0,"includepublished":false,"order":"","order2":"","order3":"","order4":"","order5":"","orderdesc":false,"orderdesc2":false,"orderdesc3":false,"orderdesc4":false,"orderdesc5":false,"page_no":0,"page_size":0,"pageinate":false,"reportgroup_id":0,"search":"","type":0}}
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 |
tickets | array | Output field: tickets |
tickets.id | number | Unique identifier |
tickets.dateoccurred | string | Output field: tickets.dateoccurred |
tickets.summary | string | Output field: tickets.summary |
tickets.status_id | number | Unique identifier |
tickets.tickettype_id | number | Unique identifier |
tickets.sla_id | number | Unique identifier |
tickets.priority_id | number | Unique identifier |
tickets.client_id | number | Unique identifier |
tickets.client_name | string | Name of the resource |
tickets.site_id | number | Unique identifier |
tickets.site_name | string | Name of the resource |
tickets.user_name | string | Name of the resource |
tickets.team | string | Output field: tickets.team |
tickets.agent_id | number | Unique identifier |
tickets.agent_name | string | Name of the resource |
tickets.category_1 | string | Output field: tickets.category_1 |
tickets.category_2 | string | Output field: tickets.category_2 |
tickets.category_3 | string | Output field: tickets.category_3 |
tickets.category_4 | string | Output field: tickets.category_4 |
Output 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 |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Get Status by ID action |
parameters.includedetails | boolean | Optional | Parameters for the Get Status by ID action |
Input Example
{"parameters":{"includedetails":false},"path_parameters":{"id":4518}}
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 |
Output 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",...
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 |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Get Team by ID action |
parameters.includeagents | boolean | Optional | Parameters for the Get Team by ID action |
parameters.includedetails | boolean | Optional | Parameters for the Get Team by ID action |
Input Example
{"parameters":{"includeagents":false,"includedetails":false},"path_parameters":{"id":4518}}
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 |
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 |
managers.id | number | Unique identifier |
managers.name | string | Name of the resource |
managers.agent_id | number | Unique identifier |
managers.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 |
agents | array | Output field: agents |
Output 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 |
|---|---|---|---|
parameters.can_edit_only | boolean | Optional | Parameters for the Get Team Names action |
parameters.chat_only | boolean | Optional | Parameters for the Get Team Names action |
parameters.department_id | number | Optional | Parameters for the Get Team Names action |
parameters.domain | string | Optional | Parameters for the Get Team Names action |
parameters.ids | string | Optional | Parameters for the Get Team Names action |
parameters.include_managers | boolean | Optional | Parameters for the Get Team Names action |
parameters.includeagentsforteams | string | Optional | Parameters for the Get Team Names action |
parameters.includedisabled | string | Optional | Parameters for the Get Team Names action |
parameters.includeenabled | string | Optional | Parameters for the Get Team Names action |
parameters.istree | boolean | Optional | Parameters for the Get Team Names action |
parameters.memberonly | boolean | Optional | Parameters for the Get Team Names action |
parameters.mydeps | boolean | Optional | Parameters for the Get Team Names action |
parameters.myteamsonly | boolean | Optional | Parameters for the Get Team Names action |
parameters.orderbyseq | boolean | Optional | Parameters for the Get Team Names action |
parameters.outcome_id | number | Optional | Parameters for the Get Team Names action |
parameters.showall | boolean | Optional | Parameters for the Get Team Names action |
parameters.showcounts | boolean | Optional | Parameters for the Get Team Names action |
parameters.ticketarea_id | number | Optional | Parameters for the Get Team Names action |
parameters.type | string | Optional | Parameters for the Get Team Names action |
parameters.view_id | number | Optional | Parameters for the Get Team Names action |
Input Example
{"parameters":{"can_edit_only":false,"chat_only":false,"department_id":0,"domain":"","ids":"","include_managers":false,"includeagentsforteams":"","includedisabled":"","includeenabled":"","istree":false,"memberonly":false,"mydeps":false,"myteamsonly":false,"orderbyseq":false,"outcome_id":0,"showall":false,"showcounts":false,"ticketarea_id":0,"type":"","view_id":0}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output 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","forrequests":true,"foropps":true,"forprojects":true,"ticket_count":0,"agents":[]}]}
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 |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Get Ticket by ID action |
parameters.amailentryid | string | Optional | Parameters for the Get Ticket by ID action |
parameters.assignedto | number | Optional | Parameters for the Get Ticket by ID action |
parameters.consignablelines | boolean | Optional | Parameters for the Get Ticket by ID action |
parameters.debug | boolean | Optional | Parameters for the Get Ticket by ID action |
parameters.dodatabaselookup | boolean | Optional | Parameters for the Get Ticket by ID action |
parameters.email | string | Optional | Parameters for the Get Ticket by ID action |
parameters.include_auditing | boolean | Optional | Parameters for the Get Ticket by ID action |
parameters.includeagent | boolean | Optional | Parameters for the Get Ticket by ID action |
parameters.includechildids | boolean | Optional | Parameters for the Get Ticket by ID action |
parameters.includedetails | boolean | Optional | Parameters for the Get Ticket by ID action |
parameters.includelastaction | boolean | Optional | Parameters for the Get Ticket by ID action |
parameters.includelastappointment | boolean | Optional | Parameters for the Get Ticket by ID action |
parameters.includelinkedobjects | boolean | Optional | Parameters for the Get Ticket by ID action |
parameters.includenextappointment | boolean | Optional | Parameters for the Get Ticket by ID action |
parameters.includeparentchangeinfo | boolean | Optional | Parameters for the Get Ticket by ID action |
parameters.includeparentsubject | boolean | Optional | Parameters for the Get Ticket by ID action |
parameters.includeseenby | boolean | Optional | Parameters for the Get Ticket by ID action |
parameters.is_portal | boolean | Optional | Parameters for the Get Ticket by ID action |
parameters.isdetailscreen | boolean | Optional | Parameters for the Get Ticket by ID action |
parameters.ishalolink | boolean | Optional | Parameters for the Get Ticket by ID action |
parameters.ispreview | boolean | Optional | Parameters for the Get Ticket by ID action |
parameters.isteams | boolean | Optional | Parameters for the Get Ticket by ID action |
parameters.nocache | boolean | Optional | Parameters for the Get Ticket by ID action |
parameters.subject | string | Optional | Parameters for the Get Ticket by ID action |
Input Example
{"parameters":{"amailentryid":"39201","assignedto":0,"consignablelines":false,"debug":false,"dodatabaselookup":false,"email":"[email protected]","include_auditing":false,"includeagent":false,"includechildids":false,"includedetails":false,"includelastaction":false,"includelastappointment":false,"includelinkedobjects":false,"includenextappointment":false,"includeparentchangeinfo":false,"includeparentsubject":false,"includeseenby":false,"is_portal":false,"isdetailscreen":false,"ishalolink":false,"ispreview":false,"isteams":false,"nocache":false,"subject":"In Process","ticketidonly":false,"utcoffset":3.4524},"path_parameters":{"id":4518}}
Output
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 |
timetaken | number | Output field: timetaken |
Output 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 |
|---|---|---|---|
parameters.domain | string | Optional | Parameters for the Get Ticket Statuses action |
parameters.excludeclosed | boolean | Optional | Parameters for the Get Ticket Statuses action |
parameters.excludepending | boolean | Optional | Parameters for the Get Ticket Statuses action |
parameters.outcome_id | number | Optional | Parameters for the Get Ticket Statuses action |
parameters.showall | boolean | Optional | Parameters for the Get Ticket Statuses action |
parameters.showcounts | boolean | Optional | Parameters for the Get Ticket Statuses action |
parameters.showquickchangeoptions | boolean | Optional | Parameters for the Get Ticket Statuses action |
parameters.split_closed | boolean | Optional | Parameters for the Get Ticket Statuses action |
parameters.ticket_id | number | Optional | Parameters for the Get Ticket Statuses action |
parameters.ticket_id_firstchild | number | Optional | Parameters for the Get Ticket Statuses action |
parameters.ticketarea_id | number | Optional | Parameters for the Get Ticket Statuses action |
parameters.tickettype_group_id | number | Optional | Parameters for the Get Ticket Statuses action |
parameters.tickettype_id | number | Optional | Parameters for the Get Ticket Statuses action |
parameters.tickettype_ids | string | Optional | Parameters for the Get Ticket Statuses action |
parameters.type | string | Optional | Parameters for the Get Ticket Statuses action |
parameters.view_id | number | Optional | Parameters for the Get Ticket Statuses action |
Input Example
{"parameters":{"domain":"","excludeclosed":false,"excludepending":false,"outcome_id":0,"showall":false,"showcounts":false,"showquickchangeoptions":false,"split_closed":false,"ticket_id":0,"ticket_id_firstchild":0,"ticketarea_id":0,"tickettype_group_id":0,"tickettype_id":0,"tickettype_ids":"","type":"","view_id":0}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output 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,"type":0,"colour":"string"}]}
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 |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Get Ticket Type by ID action |
parameters.can_create_only | boolean | Optional | Parameters for the Get Ticket Type by ID action |
parameters.can_edit_only | boolean | Optional | Parameters for the Get Ticket Type by ID action |
parameters.debug | boolean | Optional | Parameters for the Get Ticket Type by ID action |
parameters.includeconfig | boolean | Optional | Parameters for the Get Ticket Type by ID action |
parameters.includedetails | boolean | Optional | Parameters for the Get Ticket Type by ID action |
parameters.includekbinfo | boolean | Optional | Parameters for the Get Ticket Type by ID action |
parameters.includeteamrestrictions | boolean | Optional | Parameters for the Get Ticket Type by ID action |
parameters.isdetailscreen | boolean | Optional | Parameters for the Get Ticket Type by ID action |
parameters.isnewticket | boolean | Optional | Parameters for the Get Ticket Type by ID action |
parameters.survey_fields | boolean | Optional | Parameters for the Get Ticket Type by ID action |
parameters.ticket_id | number | Optional | Parameters for the Get Ticket Type by ID action |
Input Example
{"parameters":{"can_create_only":true,"can_edit_only":true,"debug":true,"includeconfig":true,"includedetails":true,"includekbinfo":true,"includeteamrestrictions":true,"isdetailscreen":true,"isnewticket":true,"survey_fields":true,"ticket_id":0},"path_parameters":{"id":4518}}
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 |
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 |
default_priority | number | Output field: default_priority |
Output 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,"close...
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 |
|---|---|---|---|
parameters.advanced_search | string | Optional | Parameters for the Get Tickets action |
parameters.agent | array | Optional | Parameters for the Get Tickets action |
parameters.agent_id | number | Optional | Parameters for the Get Tickets action |
parameters.alerttype | string | Optional | Parameters for the Get Tickets action |
parameters.asset_id | number | Optional | Parameters for the Get Tickets action |
parameters.awaitinginput | string | Optional | Parameters for the Get Tickets action |
parameters.billableonly | boolean | Optional | Parameters for the Get Tickets action |
parameters.billing_date | string | Optional | Parameters for the Get Tickets action |
parameters.billing_type | string | Optional | Parameters for the Get Tickets action |
parameters.billingcontractid | number | Optional | Parameters for the Get Tickets action |
parameters.calendar_enddate | string | Optional | Parameters for the Get Tickets action |
parameters.calendar_startdate | string | Optional | Parameters for the Get Tickets action |
parameters.category_1 | array | Optional | Parameters for the Get Tickets action |
parameters.category_2 | array | Optional | Parameters for the Get Tickets action |
parameters.category_3 | array | Optional | Parameters for the Get Tickets action |
parameters.category_4 | array | Optional | Parameters for the Get Tickets action |
parameters.checkmyticketsonly | boolean | Optional | Parameters for the Get Tickets action |
parameters.client_id | number | Optional | Parameters for the Get Tickets action |
parameters.client_ids | array | Optional | Parameters for the Get Tickets action |
parameters.client_ref | string | Optional | Parameters for the Get Tickets action |
parameters.closed_only | boolean | Optional | Parameters for the Get Tickets action |
parameters.columns_id | number | Optional | Parameters for the Get Tickets action |
parameters.contract_id | number | Optional | Parameters for the Get Tickets action |
parameters.contract_period | number | Optional | Parameters for the Get Tickets action |
parameters.count | number | Optional | Parameters for the Get Tickets action |
Input Example
{"parameters":{"advanced_search":"","agent":[1],"agent_id":0,"alerttype":"","asset_id":0,"awaitinginput":"","billableonly":true,"billing_date":"","billing_type":"","billingcontractid":0,"calendar_enddate":"","calendar_startdate":"","category_1":[1],"category_2":[1],"category_3":[1],"category_4":[1],"checkmyticketsonly":true,"client_id":0,"client_ids":[1],"client_ref":"","closed_only":true,"columns_id":0,"contract_id":0,"contract_period":0,"count":0,"datesearch":"","debug":true,"default_columns":true,"deleted":true,"domain":"","enddate":"","enddatetime":true,"excludeslacalcs":true,"excludethese":[1],"excludetickettypeallowall":true,"extraportalfilter":"","facebook_id":"","fetchgrandchildren":true,"flagged":[1],"followedandagents":[1],"ignoremilestonerestriction":true,"includeaccountmanager":true,"includeagent":true,"includeallopen":true,"includeappointmentid":true,"includeapproval":[1],"includeassetkeyfield":true,"includeassettype":true,"includebreached":[1],"includebudgettype":true,"includechildids":true,"includechildread":true,"includechildren":[1],"includeclosed":[1],"includecolumns":true,"includecompleted":true,"includecontract":true,"includecountryregion":true,"includefirstname":true,"includefollowedonly":[1],"includehold":[1],"includeinactivetechs":[1],"includeinactiveusers":[1],"includeitilname":true,"includelastaction":true,"includelastincomingemail":true,"includelastname":true,"includelastnote":true,"includelocked":true,"includemailbox":true,"includemailid":true,"includemyuseronly":[1],"includenextactivitydate":true,"includenextappointmenttype":true,"includeparentsubject":true,"includeprojects":[1],"includeread":[1],"includerelatedservices":true,"includerelease1":true,"includerelease2":true,"includerelease3":true,"includeservicecategory":true,"includeslaactiondate":true,"includeslatimer":true,"includestatus":true,"includesubmittedonly":[1],"includesupplier":true,"includetickettype":true,"includetimetaken":true,"includetoplevel":true,"includeviewing":true,"includeworkflowstage":true,"includeworkflowstagenumber":true,"includuserdepartments":true,"inlcludeopenchildcount":true,"invlucebranch":true,"ismilestone":true,"isorion":true,"isquicktimesearch":true,"isscom":true,"isteams":true,"iszapier":true,"itil_requesttype":[1],"itil_requesttype_id":0,"kanbanviewontheagentapp":true,"kanbanviewontheportal":true,"lastupdatefromdate":true,"lastupdatetodate":true,"list_id":0,"milestone_id":0,"mine":true,"nochargeonly":true,"notime":true,"onlytime":true,"open_only":true,"order":"","order2":"","order3":"","order4":"","order5":"","orderdesc":true,"orderdesc2":true,"orderdesc3":true,"orderdesc4":true,"orderdesc5":true,"orion_type":0,"page_no":0,"page_size":0,"pageinate":true,"parent_id":0,"pending_review":true,"per_action":true,"prepayorcontractonly":true,"priority":[1],"product":[1],"project_ids":"","ready_for_invoicing":true,"related_id":0,"release_id":0,"requesttype":[1],"requesttype_id":0,"requesttypegroup":[1],"search":"","search_details":"","search_id":"","search_inventory_number":"","search_oppcompanyname":"","search_oppcontactname":"","search_oppemailaddress":"","search_release1":"","search_release2":"","search_release3":"","search_releasenote":"","search_reportedby":"","search_summary":"","search_supplier_reference":"","search_user_name":"","search_version":"","searchactions":true,"searchthisticketid":0,"service_id":0,"showonroadmap":[1],"site_id":0,"sitepostcode":true,"sla":[1],"sprint_for_tickettype_id":0,"sprints":true,"startandendset":true,"startdate":"","startdatetime":true,"status":[1],"status_id":0,"submittedandagents":[1],"supplier_id":0,"supplier_status":[1],"team":[1],"team_name":"","ticketarea_id":0,"ticketcontract_id":0,"ticketidonly":true,"ticketids":"","ticketlinktype":0,"toplevel_id":0,"unlinked_only":true,"user_id":0,"username":"","utcoffset":3.1234,"view_id":0,"withattachments":true}}
Output
Parameter | Type | Description |
|---|---|---|
status_code | number | HTTP status code of the response |
reason | string | Response reason phrase |
Output 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
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 |
Output 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 |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Retrieve Client by ID action |
parameters.domain | string | Optional | Parameters for the Retrieve Client by ID action |
parameters.getavailablerts | boolean | Optional | Parameters for the Retrieve Client by ID action |
parameters.includeactivity | boolean | Optional | Parameters for the Retrieve Client by ID action |
parameters.includedetails | boolean | Optional | Parameters for the Retrieve Client by ID action |
parameters.includeperiods | boolean | Optional | Parameters for the Retrieve Client by ID action |
parameters.includeprepay | boolean | Optional | Parameters for the Retrieve Client by ID action |
parameters.tickettype_id | number | Optional | Parameters for the Retrieve Client by ID action |
Input Example
{"parameters":{"domain":"","getavailablerts":true,"includeactivity":true,"includedetails":true,"includeperiods":true,"includeprepay":true,"tickettype_id":0},"path_parameters":{"id":4518}}
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 |
Output 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 |
|---|---|---|---|
parameters.accountmanageronly | boolean | Optional | Parameters for the Retrieve Client Records action |
parameters.activeinactive | string | Optional | Parameters for the Retrieve Client Records action |
parameters.advanced_search | string | Optional | Parameters for the Retrieve Client Records action |
parameters.azureclients | boolean | Optional | Parameters for the Retrieve Client Records action |
parameters.callplan | boolean | Optional | Parameters for the Retrieve Client Records action |
parameters.columns_id | number | Optional | Parameters for the Retrieve Client Records action |
parameters.count | number | Optional | Parameters for the Retrieve Client Records action |
parameters.domain | string | Optional | Parameters for the Retrieve Client Records action |
parameters.exclude_internal | boolean | Optional | Parameters for the Retrieve Client Records action |
parameters.gficlients | boolean | Optional | Parameters for the Retrieve Client Records action |
parameters.idonly | boolean | Optional | Parameters for the Retrieve Client Records action |
parameters.includeactive | boolean | Optional | Parameters for the Retrieve Client Records action |
parameters.includeazuretenants | boolean | Optional | Parameters for the Retrieve Client Records action |
parameters.includecolumns | boolean | Optional | Parameters for the Retrieve Client Records action |
parameters.includeinactive | boolean | Optional | Parameters for the Retrieve Client Records action |
parameters.includeinvoicetemplatename | boolean | Optional | Parameters for the Retrieve Client Records action |
parameters.includenotes | boolean | Optional | Parameters for the Retrieve Client Records action |
parameters.includeqbofields | boolean | Optional | Parameters for the Retrieve Client Records action |
parameters.integration_tenantids | array | Optional | Parameters for the Retrieve Client Records action |
parameters.integration_type | string | Optional | Parameters for the Retrieve Client Records action |
parameters.isjira | boolean | Optional | Parameters for the Retrieve Client Records action |
parameters.issentinel | boolean | Optional | Parameters for the Retrieve Client Records action |
parameters.isservicenow | boolean | Optional | Parameters for the Retrieve Client Records action |
parameters.lastupdatefromdate | boolean | Optional | Parameters for the Retrieve Client Records action |
parameters.lastupdatetodate | boolean | Optional | Parameters for the Retrieve Client Records action |
Input Example
{"parameters":{"accountmanageronly":true,"activeinactive":"","advanced_search":"","azureclients":true,"callplan":true,"columns_id":0,"count":0,"domain":"","exclude_internal":true,"gficlients":true,"idonly":true,"includeactive":true,"includeazuretenants":true,"includecolumns":true,"includeinactive":true,"includeinvoicetemplatename":true,"includenotes":true,"includeqbofields":true,"integration_tenantids":[1],"integration_type":"","isjira":true,"issentinel":true,"isservicenow":true,"lastupdatefromdate":true,"lastupdatetodate":true,"order":"","order2":"","order3":"","order4":"","order5":"","orderdesc":true,"orderdesc2":true,"orderdesc3":true,"orderdesc4":true,"orderdesc5":true,"page_no":0,"page_size":0,"pageinate":true,"search":"","search_name_only":"","sentinelid":0,"showcounts":true,"sitefields":"","snowaccountid":0,"snowclients":true,"ticketarea_id":0,"toplevel_id":0,"view_id":0}}
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 |
clients.id | number | Unique identifier |
clients.name | string | Name of the resource |
clients.colour | string | Output field: clients.colour |
clients.inactive | boolean | Output field: clients.inactive |
clients.toplevel_id | number | Unique identifier |
clients.toplevel_name | string | Name of the resource |
clients.customfields | array | Output field: clients.customfields |
clients.customfields.id | number | Unique identifier |
clients.customfields.name | string | Name of the resource |
clients.customfields.label | string | Output field: clients.customfields.label |
clients.customfields.type | number | Type of the resource |
clients.customfields.value | object | Value for the parameter |
clients.customfields.display | string | Output field: clients.customfields.display |
clients.customfields.characterlimit | number | Output field: clients.customfields.characterlimit |
clients.customfields.characterlimittype | number | Type of the resource |
clients.customfields.inputtype | number | Input data for the action |
Output 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 |
|---|---|---|---|
path_parameters.id | number | Required | Parameters for the Retrieve Halo User by ID action |
parameters.client_id | number | Optional | Parameters for the Retrieve Halo User by ID action |
parameters.client_override | number | Optional | Parameters for the Retrieve Halo User by ID action |
parameters.domain | string | Optional | Parameters for the Retrieve Halo User by ID action |
parameters.includeactivity | boolean | Optional | Parameters for the Retrieve Halo User by ID action |
parameters.includebillinginfo | boolean | Optional | Parameters for the Retrieve Halo User by ID action |
parameters.includedetails | boolean | Optional | Parameters for the Retrieve Halo User by ID action |
parameters.includepopups | boolean | Optional | Parameters for the Retrieve Halo User by ID action |
parameters.includeusersassets | boolean | Optional | Parameters for the Retrieve Halo User by ID action |
parameters.issetup | boolean | Optional | Parameters for the Retrieve Halo User by ID action |
parameters.opp_id | number | Optional | Parameters for the Retrieve Halo User by ID action |
parameters.site_id | number | Optional | Parameters for the Retrieve Halo User by ID action |
parameters.site_override | number | Optional | Parameters for the Retrieve Halo User by ID action |
parameters.supplier_id | number | Optional | Parameters for the Retrieve Halo User by ID action |
parameters.tickettype_id | number | Optional | Parameters for the Retrieve Halo User by ID action |
parameters.username | string | Optional | Parameters for the Retrieve Halo User by ID action |
Input Example
{"parameters":{"client_id":0,"client_override":0,"domain":"","includeactivity":false,"includebillinginfo":false,"includedetails":false,"includepopups":false,"includeusersassets":false,"issetup":false,"opp_id":0,"site_id":0,"site_override":0,"supplier_id":0,"tickettype_id":0,"username":""},"path_parameters":{"id":4518}}
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 |
Output 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 |
|---|---|---|---|
parameters.activeinactive | string | Optional | Parameters for the Retrieve Halo Users action |
parameters.advanced_search | string | Optional | Parameters for the Retrieve Halo Users action |
parameters.allapprovers | boolean | Optional | Parameters for the Retrieve Halo Users action |
parameters.approvers_only | boolean | Optional | Parameters for the Retrieve Halo Users action |
parameters.asset_id | number | Optional | Parameters for the Retrieve Halo Users action |
parameters.client_id | number | Optional | Parameters for the Retrieve Halo Users action |
parameters.contract_id | number | Optional | Parameters for the Retrieve Halo Users action |
parameters.count | number | Optional | Parameters for the Retrieve Halo Users action |
parameters.department_id | number | Optional | Parameters for the Retrieve Halo Users action |
parameters.exclude_agents | boolean | Optional | Parameters for the Retrieve Halo Users action |
parameters.exclude_defaultsiteusers | boolean | Optional | Parameters for the Retrieve Halo Users action |
parameters.exclude_generaluser | boolean | Optional | Parameters for the Retrieve Halo Users action |
parameters.idonly | boolean | Optional | Parameters for the Retrieve Halo Users action |
parameters.includeactive | boolean | Optional | Parameters for the Retrieve Halo Users action |
parameters.includebillinginfo | boolean | Optional | Parameters for the Retrieve Halo Users action |
parameters.includeinactive | boolean | Optional | Parameters for the Retrieve Halo Users action |
parameters.includename | boolean | Optional | Parameters for the Retrieve Halo Users action |
parameters.includenonserviceaccount | boolean | Optional | Parameters for the Retrieve Halo Users action |
parameters.includenotes | boolean | Optional | Parameters for the Retrieve Halo Users action |
parameters.includeserviceaccount | boolean | Optional | Parameters for the Retrieve Halo Users action |
parameters.integration_type | string | Optional | Parameters for the Retrieve Halo Users action |
parameters.is_followers | boolean | Optional | Parameters for the Retrieve Halo Users action |
parameters.is3cxcall | boolean | Optional | Parameters for the Retrieve Halo Users action |
parameters.lastupdatefromdate | boolean | Optional | Parameters for the Retrieve Halo Users action |
parameters.lastupdatetodate | boolean | Optional | Parameters for the Retrieve Halo Users action |
Input Example
{"parameters":{"activeinactive":"","advanced_search":"","allapprovers":false,"approvers_only":false,"asset_id":0,"client_id":0,"contract_id":0,"count":0,"department_id":0,"exclude_agents":false,"exclude_defaultsiteusers":false,"exclude_generaluser":false,"idonly":false,"includeactive":false,"includebillinginfo":false,"includeinactive":false,"includename":false,"includenonserviceaccount":false,"includenotes":false,"includeserviceaccount":false,"integration_type":"","is_followers":false,"is3cxcall":false,"lastupdatefromdate":false,"lastupdatetodate":false,"licence_id":0,"listagentuserfirst":false,"myallcustomers":false,"myarea":false,"mydepartment":false,"mysite":false,"mysitecontact":false,"mytoplevel":false,"opp_id":0,"order":"","order2":"","order3":"","order4":"","order5":"","orderdesc":false,"orderdesc2":false,"orderdesc3":false,"orderdesc4":false,"orderdesc5":false,"organisation_id":0,"page_no":0,"page_size":0,"pageinate":false,"role":0,"search":"","search_phonenumbers":false,"site_id":0,"supplier_id":0,"tickettype_id":0,"toplevel_id":0}}
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 |
users | array | Output field: users |
users.id | number | Unique identifier |
users.name | string | Name of the resource |
users.site_name | string | Name of the resource |
users.actived | string | Output field: users.actived |
users.emailaddress | string | Output field: users.emailaddress |
users.phonenumber | string | Output field: users.phonenumber |
users.fax | string | Output field: users.fax |
users.firstname | string | Name of the resource |
users.inactive | boolean | Output field: users.inactive |
users.surname | string | Name of the resource |
users.login | string | Output field: users.login |
users.mobilenumber | string | Output field: users.mobilenumber |
users.mobilenumber2 | string | Output field: users.mobilenumber2 |
users.site_id | number | Unique identifier |
users.homenumber | string | Output field: users.homenumber |
users.telpref | number | Output field: users.telpref |
users.title | string | Output field: users.title |
users.client_id | number | Unique identifier |
users.client_name | string | Name of the resource |
Output 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
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 |
Output 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 |
|---|---|---|---|
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 |
zoomy | number | Optional | Parameter for Update Halo Site |
Input Example
{"json_body":{"id":0,"name":"","client_id":0,"client_name":"","clientsite_name":"","inactive":true,"sla_id":0,"phonenumber":"","colour":"","timezone":"","invoice_address_isdelivery":true,"datecreated":"2019-08-02T14:35:57.189Z","text":0,"globx":0,"globy":0,"style":0,"inuseby":0,"notes":"","upwho":0,"uptimestamp":"2019-08-02T14:35:57.189Z","xrefsite":0,"zoffsetx":0,"zoffsety":0,"zoomx":0,"zoomy":0,"smallx":0,"smally":0,"bigx":0,"bigy":0,"ldapstring":"","emaildomain":"","deliverby":0,"isinvoicesite":true,"refnumber":0,"defaultdelivery":true,"seriousnesslevel":0,"geocoord1":0,"geocoord2":0,"todomain":"","defaultstocklocation":0,"stopped":0,"gfisiteid":0,"itetimeoffset":0,"itedateformat":0,"disclaimermatchstring":"","emailsubjectprefix":"","regionaldirector":0,"facilitiesmanager":0,"actguid":"","teamviewerpassword":"","contractlastchecked":"2019-08-02T14:35:57.189Z","maincontact_id":0,"maincontact_name":"","wildcardref":"","monthlyreportlastrun":"2019-08-02T14:35:57.189Z","monthlyreportinclude":true,"monthlyreportemailmanager":true,"accountmanagertech":true,"monthlyreportemaildirect":true,"language_id":0,"language_name":"","snowname":"","linked_organisation_id":0,"client":{},"users_update":[{}],"newsite_contactname":"","newsite_contactemail":"","newsite_contacttitle":"","newsite_web_access_level":0,"newsite_sendwelcomeemail":true,"delivery_address":{},"invoice_address":{},"popup_notes":[{}],"_reassign_all_to_user":0,"fields":[{}],"licences":[{}],"open_ticket_count":0,"onhold_ticket_count":0,"total_ticket_count":0,"opened_thismonth_count":0,"guid":"","_warning":"","customfields":[{}]}}
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 |
Output 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
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 |
Output 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
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 |
Output 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
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 |
Output 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
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 |
Output 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 | Mon, 29 Apr 2024 05:54:47 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 |