Axios Assyst

Axios Assyst is an IT Service Management solution that streamlines IT service delivery and support.

Axios Assyst is a comprehensive IT service management (ITSM) platform designed to streamline and automate IT processes. The Axios Assyst Connector for Swimlane Turbine enables seamless integration with Axios Assyst, allowing users to automate ticket management, event tracking, and response actions. By leveraging this integration, Swimlane Turbine end-users can enhance their ITSM workflows, reduce manual effort, and improve incident response times, ultimately leading to more efficient and effective IT operations.

Prerequisites

Before you can use the Axios Assyst connector for Turbine, you'll need access to the Axios Assyst API. This requires the following:

HTTP Basic authentication using the following parameters:

URL: The endpoint URL for accessing Axios Assyst API.

Username: Your Axios Assyst account username.

Password: The password associated with your Axios Assyst account.

Asset Setup

Username and Password are needed to authenticate with Axios Assyst.

Additional Documentation

Axios Assyst Connector Documentation

Axios Assyst API Documentation

Configurations

HTTP Basic Authentication

Authenticates using username and password.

Configuration Parameters

Parameter	Description	Type	Required
url	A URL to the target host.	string	Required
username	Username	string	Required
password	Password	string	Required
verify_ssl	Verify SSL certificate	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

Actions

Close a Ticket

Close an existing ticket in Axios Assyst using the specified eventId provided in the JSON body.

Endpoint

URL: assystREST/v2/actions

Method: POST

Input

Argument Name	Type	Required	Description
eventId	string	Optional	Unique identifier
actionType	object	Optional	Type of the resource
actionType.resolvingParameters	array	Optional	Parameters for the Close a Ticket action
actionType.resolvingParameters.parameterName	string	Optional	Parameters for the Close a Ticket action
actionType.resolvingParameters.parameterValue	string	Optional	Parameters for the Close a Ticket action
causeItem	object	Optional	Parameter for Close a Ticket
causeItem.resolvingParameters	array	Optional	Parameters for the Close a Ticket action
causeItem.resolvingParameters.parameterName	string	Optional	Parameters for the Close a Ticket action
causeItem.resolvingParameters.parameterValue	string	Optional	Parameters for the Close a Ticket action
causeCategory	object	Optional	Parameter for Close a Ticket
causeCategory.resolvingParameters	array	Optional	Parameters for the Close a Ticket action
causeCategory.resolvingParameters.parameterName	string	Optional	Parameters for the Close a Ticket action
causeCategory.resolvingParameters.parameterValue	string	Optional	Parameters for the Close a Ticket action
remarks	string	Optional	Parameter for Close a Ticket

Input Example

{"eventId":"string","actionType":{"resolvingParameters":[{"parameterName":"Example Name","parameterValue":"string"}]},"causeItem":{"resolvingParameters":[{"parameterName":"Example Name","parameterValue":"string"}]},"causeCategory":{"resolvingParameters":[{"parameterName":"Example Name","parameterValue":"string"}]},"remarks":"string"}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
id	number	Unique identifier
version	number	Output field: version
objectAvailable	boolean	Output field: objectAvailable
systemRecordFlag	boolean	Output field: systemRecordFlag
entityDefinitionType	number	Type of the resource
cacheable	boolean	Output field: cacheable
dataLocale	string	Response data
richRemarks	object	Output field: richRemarks
richRemarks.content	string	Response content
richRemarks.plainTextContent	string	Response content
modifyId	string	Unique identifier
modifyDate	string	Date value
discontinued	boolean	Output field: discontinued
eventId	number	Unique identifier
actioningServDeptId	number	Unique identifier
actionedById	number	Unique identifier
chargeCodeId	number	Unique identifier
causeItemId	number	Unique identifier
causeCategoryId	number	Unique identifier
dateActioned	string	Output field: dateActioned
serviceTime	object	Time value
serviceTime.value	number	Value for the parameter
serviceTime.isSetToNull	boolean	Output field: serviceTime.isSetToNull

Output Example

{"id":123,"version":123,"objectAvailable":true,"systemRecordFlag":true,"entityDefinitionType":123,"cacheable":true,"dataLocale":"string","richRemarks":{"content":"string","plainTextContent":"string"},"modifyId":"string","modifyDate":"string","discontinued":true,"eventId":123,"actioningServDeptId":123,"actionedById":123,"chargeCodeId":123}

Create a Ticket

Initiate the creation of a new ticket in Axios Assyst using provided details in the JSON body.

Endpoint

URL: assystREST/v2/events

Method: POST

Input

Argument Name	Type	Required	Description
affectedUser	object	Optional	Parameter for Create a Ticket
affectedUser.resolvingParameters	array	Optional	Parameters for the Create a Ticket action
affectedUser.resolvingParameters.parameterName	string	Optional	Parameters for the Create a Ticket action
affectedUser.resolvingParameters.parameterValue	string	Optional	Parameters for the Create a Ticket action
severity	string	Optional	Parameter for Create a Ticket
template	string	Optional	Parameter for Create a Ticket
eventTypeEnum	string	Optional	Type of the resource
description	string	Optional	Parameter for Create a Ticket
shortDescription	string	Optional	Parameter for Create a Ticket
remarks	string	Optional	Parameter for Create a Ticket
itemA	object	Optional	Parameter for Create a Ticket
itemA.resolvingParameters	array	Optional	Parameters for the Create a Ticket action
itemA.resolvingParameters.parameterName	string	Optional	Parameters for the Create a Ticket action
itemA.resolvingParameters.parameterValue	string	Optional	Parameters for the Create a Ticket action
category	object	Optional	Parameter for Create a Ticket
category.resolvingParameters	array	Optional	Parameters for the Create a Ticket action
category.resolvingParameters.parameterName	string	Optional	Parameters for the Create a Ticket action
category.resolvingParameters.parameterValue	string	Optional	Parameters for the Create a Ticket action
priority	object	Optional	Parameter for Create a Ticket
priority.resolvingParameters	array	Optional	Parameters for the Create a Ticket action
priority.resolvingParameters.parameterName	string	Optional	Parameters for the Create a Ticket action
priority.resolvingParameters.parameterValue	string	Optional	Parameters for the Create a Ticket action
seriousness	object	Optional	Parameter for Create a Ticket
seriousness.resolvingParameters	array	Optional	Parameters for the Create a Ticket action
seriousness.resolvingParameters.parameterName	string	Optional	Parameters for the Create a Ticket action

Input Example

{"affectedUser":{"resolvingParameters":[{"parameterName":"Example Name","parameterValue":"string"}]},"severity":"string","template":"string","eventTypeEnum":"string","description":"string","shortDescription":"string","remarks":"string","itemA":{"resolvingParameters":[{"parameterName":"Example Name","parameterValue":"string"}]},"category":{"resolvingParameters":[{"parameterName":"Example Name","parameterValue":"string"}]},"priority":{"resolvingParameters":[{"parameterName":"Example Name","parameterValue":"string"}]},"seriousness":{"resolvingParameters":[{"parameterName":"Example Name","parameterValue":"string"}]},"csg":{"resolvingParameters":[{"parameterName":"Example Name","parameterValue":"string"}]}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
id	number	Unique identifier
version	number	Output field: version
objectAvailable	boolean	Output field: objectAvailable
systemRecordFlag	boolean	Output field: systemRecordFlag
entityDefinitionType	number	Type of the resource
entityDefinitionId	number	Unique identifier
cacheable	boolean	Output field: cacheable
dataLocale	string	Response data
richRemarks	object	Output field: richRemarks
richRemarks.content	string	Response content
richRemarks.plainTextContent	string	Response content
modifyId	string	Unique identifier
modifyDate	string	Date value
discontinued	boolean	Output field: discontinued
csgId	number	Unique identifier
csgShortCode	string	Output field: csgShortCode
csgEnabled	boolean	Output field: csgEnabled
csgActive	boolean	Output field: csgActive
csg	object	Output field: csg
csg.id	number	Unique identifier
csg.version	number	Output field: csg.version
csg.objectAvailable	boolean	Output field: csg.objectAvailable
csg.systemRecordFlag	boolean	Output field: csg.systemRecordFlag

Output Example

{"id":123,"version":123,"objectAvailable":true,"systemRecordFlag":true,"entityDefinitionType":123,"entityDefinitionId":123,"cacheable":true,"dataLocale":"string","richRemarks":{"content":"string","plainTextContent":"string"},"modifyId":"string","modifyDate":"string","discontinued":true,"csgId":123,"csgShortCode":"string","csgEnabled":true}

Get Events

Fetches a list of events from Axios Assyst, providing an overview of incidents and service requests.

Endpoint

URL: /assystREST/v2/events

Method: GET

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

[]

Get Event by ID

Retrieve detailed information for an event in Axios Assyst using the specified unique identifier.

Endpoint

URL: /assystREST/v2/events/{{id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.id	number	Required	Parameters for the Get Event by ID action

Input Example

{"path_parameters":{"id":1}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
id	number	Unique identifier
version	number	Output field: version
objectAvailable	boolean	Output field: objectAvailable
systemRecordFlag	boolean	Output field: systemRecordFlag
entityDefinitionType	number	Type of the resource
entityDefinitionId	number	Unique identifier
cacheable	boolean	Output field: cacheable
dataLocale	string	Response data
richRemarks	object	Output field: richRemarks
richRemarks.content	string	Response content
richRemarks.plainTextContent	string	Response content
modifyId	string	Unique identifier
modifyDate	string	Date value
discontinued	boolean	Output field: discontinued
csgId	number	Unique identifier
csgShortCode	string	Output field: csgShortCode
csgEnabled	boolean	Output field: csgEnabled
csgActive	boolean	Output field: csgActive
incDataVersion	number	Response data
dateLogged	string	Output field: dateLogged
affectedUserId	number	Unique identifier
affectedUserName	string	Name of the resource
affectedUserTelephone	string	Output field: affectedUserTelephone

Output Example

Ticket Response

Respond to an Axios Assyst ticket by updating the event with a specific ID, remarks, and action type.

Endpoint

URL: assystREST/v2/actions

Method: POST

Input

Argument Name	Type	Required	Description
eventId	number	Optional	Unique identifier
remarks	string	Optional	Parameter for Ticket Response
actionType	object	Optional	Type of the resource
actionType.resolvingParameters	array	Required	Parameters for the Ticket Response action
actionType.resolvingParameters.parameterName	string	Required	Parameters for the Ticket Response action
actionType.resolvingParameters.parameterValue	string	Required	Parameters for the Ticket Response action

Input Example

{"json_body":{"eventId":12210617,"remarks":"Response from swimlane","actionType":{"resolvingParameters":[{"parameterName":"shortCode","parameterValue":"RESPONSE"}]}}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
id	number	Unique identifier
version	number	Output field: version
objectAvailable	boolean	Output field: objectAvailable
systemRecordFlag	boolean	Output field: systemRecordFlag
entityDefinitionType	number	Type of the resource
cacheable	boolean	Output field: cacheable
dataLocale	string	Response data
richRemarks	object	Output field: richRemarks
richRemarks.content	string	Response content
richRemarks.plainTextContent	string	Response content
modifyId	string	Unique identifier
modifyDate	string	Date value
discontinued	boolean	Output field: discontinued
eventId	number	Unique identifier
actioningServDeptId	number	Unique identifier
actionedById	number	Unique identifier
chargeCodeId	number	Unique identifier
causeItemId	number	Unique identifier
causeCategoryId	number	Unique identifier
dateActioned	string	Output field: dateActioned
serviceTime	object	Time value
serviceTime.value	number	Value for the parameter
serviceTime.isSetToNull	boolean	Output field: serviceTime.isSetToNull

Output Example

{"status_code":201,"response_headers":{"Expires":"Thu, 01 Jan 1970 00:00:00 GMT, 0","Cache-control":"no-store, no-cache, must-revalidate, no-cache, no-store, must-revalidate","X-XSS-Protection":"1; mode=block","Pragma":"no-cache, no-cache","X-Frame-Options":"SAMEORIGIN","Referrer-Policy":"strict-origin","Content-Security-Policy":"default-src 'self'; frame-src 'self' https://preprodassyst.abfoods.com:7000; scr...","Date":"Wed, 18 Jan 2023 19:18:40 GMT","Connection":"keep-alive","Vary":"Accept-Enc...

Generic Action

Execute a generic action in Axios Assyst that offers complete control over handling a request.

Input

Argument Name	Type	Required	Description
endpoint	string	Optional	Path to the endpoint after url in asset. Use double brackets with path parameters for dynamic URLs.
method	string	Optional	Method of the request such as: POST, GET, PUT, PATCH, DELETE. (Note, others are available to use)
data_body	object	Optional	Body to send as data, this allows you to set the content-type in the headers manually.
headers	object	Optional	Request headers to send with the individual request.
raw_payload	string	Optional	Raw JSON string to be serialized

Input Example

{"endpoint":"api/v3/users"}

Output

Parameter	Type	Description
status_code	number	The HTTP response status code
data	object	The JSON response body
response_text	string	Output field: response_text
reason	string	The HTTP reason, often times an error message can be here. OK means success.

Output Example

{"response_text":"string"}

Response Headers

Header	Description	Example
Cache-control	Directives for caching mechanisms	no-store, no-cache, must-revalidate, no-cache, no-store, must-revalidate
Connection	HTTP response header: Connection	keep-alive
Content-Encoding	HTTP response header: Content-Encoding	gzip
Content-Length	The length of the response body in bytes	651
Content-Security-Policy	HTTP response header: Content-Security-Policy	default-src 'self'; frame-src 'self' https://preprodassyst.abfoods.com:7000; script-src 'self' 'unsafe-eval' 'unsafe-inline'; connect-src 'self' https://dojotoolkit.org https://preprodassyst.abfoods.com:7000; object-src 'self'; img-src * data: blob:; style-src 'self' 'unsafe-inline'; font-src 'self'
Content-Type	The media type of the resource	application/json
Date	The date and time at which the message was originated	Thu, 01 Jan 2024 00:00:00 GMT
Expires	The date/time after which the response is considered stale	Thu, 01 Jan 1970 00:00:00 GMT, 0
Permissions-Policy	HTTP response header: Permissions-Policy	accelerometer=(),camera=(),geolocation=(),gyroscope=(),magnetometer=(),microphone=(),payment=(),usb=(),screen-wake-lock=(),ambient-light-sensor=(),autoplay=()
Pragma	HTTP response header: Pragma	no-cache, no-cache
Referrer-Policy	HTTP response header: Referrer-Policy	strict-origin
Set-Cookie	HTTP response header: Set-Cookie	BIGipServerUKS_16120200_Pool=67967660.36895.0000; path=/; Httponly; Secure, TS01cc7dc3=012f4b23b72aead9f7111d37a6285b1b74e544dba9806861e7335859908dd4ad96f55222c0cbc0c5a22a30e45a99d0948538566038c8dd29f6a98cc00c00716a6fd3b186c9; Path=/; Secure; HTTPOnly
Strict-Transport-Security	HTTP response header: Strict-Transport-Security	max-age=31536000
Vary	HTTP response header: Vary	Accept-Encoding
Via	HTTP response header: Via	1.1 dca1-bit12012
X-assyst-session	HTTP response header: X-assyst-session	true
X-Content-Type-Options	HTTP response header: X-Content-Type-Options	nosniff
X-Frame-Options	HTTP response header: X-Frame-Options	SAMEORIGIN
X-XSS-Protection	HTTP response header: X-XSS-Protection	1; mode=block