Axios Assyst
28 min
the axios assyst connector allows for streamlined incident management by enabling automated ticket creation, updates, and closures directly through the swimlane platform axios assyst is a robust it service management (itsm) platform that facilitates the management of it services, incidents, and requests this connector enables swimlane turbine users to integrate with axios assyst, allowing for the automation of ticket management tasks such as creating, closing, and fetching tickets, as well as responding to events and executing custom actions by leveraging this integration, users can streamline their itsm processes, reduce manual effort, and ensure a swift response to it incidents and service requests within their security operations prerequisites to effectively utilize the axios assyst connector with swimlane turbine, ensure you have the following http basic authentication with the following parameters url the endpoint url for the axios assyst api username your axios assyst account username password your axios assyst account password asset setup username and password are needed to authenticate with axios assyst 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 closes 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 initiates 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 retrieves 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 {"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} 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