Ivanti Neurons for ITSM

this connector integrates ivanti neurons for itsm's rest api with swimlane turbine prerequisites this connector requires the following input parameters to authenticate url api key capabilities this connector provides the following capabilities create a business object get a business object by rec id or unique key get all business objects update a business object notes ensure the business object name is suffixed with an "s" for information see the https //help ivanti com/ht/help/en us/ism/2020/admin/content/configure/api/get business objects htm configurations ivanti neurons for itsm api key authentication authenticates using an api key configuration parameters parameter description type required url a url to the target host string required authorization api key string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions create a business object you can create business objects available out of the box, such as a change, problem, incident, or any custom defined business object of your choice endpoint url /api/odata/businessobject/{{business object name}} method post input argument name type required description path parameters business object name string required parameters for the create a business object action category string optional parameter for create a business object createdby string optional parameter for create a business object requestorlink recid string optional unique identifier description string optional parameter for create a business object owner string optional parameter for create a business object ownerteam string optional parameter for create a business object subject string optional parameter for create a business object ownerteam valid string optional unique identifier owner valid string optional unique identifier status string optional status value typeofchange string optional type of the resource input example {"json body" {"category" "computer","createdby" "admin","requestorlink recid" "fb884d18f7b746a0992880f2dffe749c","description" "test","owner" "bheath","ownerteam" "accounting","subject" "test","ownerteam valid" "8d796372096546ac9008c0edab18ee5f","owner valid" "147098ad139247f6b177042064c5e39c","status" "logged","typeofchange" "minor"},"path parameters" {"business object name" "changes"}} output parameter type description status code number http status code of the response reason string response reason phrase @odata context string response data acceptanceduedate string date value accepttimeout string output field accepttimeout backoutplanattached boolean output field backoutplanattached ballotcount object count value businessfunction valid object unique identifier businessfunction object output field businessfunction category valid string unique identifier category string output field category changenumber number output field changenumber closedby object output field closedby closedcode valid object unique identifier closedcode object output field closedcode closeddatetime string time value completedby object output field completedby createdby string output field createdby createdbyrecid string unique identifier createddatetime string time value directcost number output field directcost emergency boolean output field emergency estimatedcost number output field estimatedcost externalcalendarlinkid object unique identifier externaltasklinkid object unique identifier output example {"status code" 200,"reason" "ok","response headers" {},"json body" {"odata context" "http //{tenant url}/api/odata/change/$metadata#changes/$entity","acceptanceduedate" "0001 01 01t00 00 00z","accepttimeout" "0001 01 01t00 00 00z","backoutplanattached"\ false,"ballotcount"\ null,"businessfunction valid"\ null,"businessfunction"\ null,"category valid" "18fcf302685c41a9ab4d4e6c52123a56","category" "computer","changenumber" 0,"closedby"\ null,"closedcode valid"\ null,"closedcode"\ null,"closeddatetime" "0 get a business object by rec id or unique key this endpoint allows the user to retrieve business objects like change, problem, incident by its rec id or unique key endpoint url /api/odata/businessobject/{{business object name}}(‘{{business object uniquekey}}’) method get input argument name type required description path parameters business object name string required ensure the business object name is suffixed with an "s" path parameters business object uniquekey string required parameters for the get a business object by rec id or unique key action input example {"path parameters" {"business object name" "changes","business object uniquekey" "02818a8426c9402e8dfe7c8d3132f783"}} output parameter type description status code number http status code of the response reason string response reason phrase odata context string response data acceptanceduedate string date value accepttimeout string output field accepttimeout backoutplanattached boolean output field backoutplanattached ballotcount object count value businessfunction valid string unique identifier businessfunction string output field businessfunction category valid string unique identifier category string output field category changenumber number output field changenumber closedby object output field closedby closedcode valid string unique identifier closedcode string output field closedcode closeddatetime string time value completedby string output field completedby createdby string output field createdby recid string unique identifier risklevel valid string unique identifier risklevel string output field risklevel riskcataloglink category string output field riskcataloglink category riskcataloglink recid string unique identifier riskcataloglink object output field riskcataloglink releaselink category string output field releaselink category output example {"status code" 200,"reason" "ok","response headers" {},"json body" {"odata context" "https //frs dev tenant saasitdev com/api/odata/change/$metadata#changes/$entity","acceptanceduedate" "0001 01 01t00 00 00z","accepttimeout" "0001 01 01t00 00 00z","backoutplanattached"\ false,"ballotcount"\ null,"businessfunction valid" "","businessfunction" "","category valid" "e0234286776b43c39231635c7066f369","category" "software","changenumber" 10173,"closedby"\ null,"closedcode valid" "","closedcode" "","close get all business objects fetches all records for the specified business object type endpoint url /api/odata/businessobject/{{business object name}} method get input argument name type required description path parameters business object name string required ensure the business object name is suffixed with an "s" input example {"path parameters" {"business object name" "incidents"}} output parameter type description status code number http status code of the response reason string response reason phrase @odata context string response data @odata count number response data actualcategory valid string unique identifier actualcategory string output field actualcategory category valid string unique identifier category string output field category causecode valid object unique identifier causecode object output field causecode closedby object output field closedby createdby string output field createdby recid string unique identifier loginid string unique identifier output example {"status code" 200,"reason" "ok","response headers" {},"json body" {"odata context" "https //{tenant url}/api/odata/$metadata#incidents","odata count" 44,"actualcategory valid" "71754ac55675467b8bede187dec5d392","actualcategory" "backup","category valid" "71754ac55675467b8bede187dec5d392","category" "backup","causecode valid"\ null,"causecode"\ null,"closedby"\ null,"createdby" "frs qa","recid" "013ccf80552c43f881be6741981cfeb7","loginid" "agreen"}} update a business object you can update details of a business object such as a change, problem, or incident endpoint url /api/odata/businessobject/{{business object name}}(‘{{business object uniquekey}}’) method put input argument name type required description path parameters business object name string required ensure the business object name is suffixed with an "s" path parameters business object uniquekey string required parameters for the update a business object action input example {"path parameters" {"business object name" "changes","business object uniquekey" "02818a8426c9402e8dfe7c8d3132f783"}} output parameter type description status code number http status code of the response reason string response reason phrase @odata context string response data acceptanceduedate string date value accepttimeout string output field accepttimeout backoutplanattached boolean output field backoutplanattached ballotcount object count value businessfunction valid string unique identifier businessfunction string output field businessfunction category valid string unique identifier category string output field category changenumber number output field changenumber closedby object output field closedby closedcode valid string unique identifier closedcode string output field closedcode closeddatetime string time value completedby string output field completedby createdby string output field createdby createdbyrecid string unique identifier createddatetime string time value directcost number output field directcost emergency boolean output field emergency estimatedcost number output field estimatedcost output example {"status code" 200,"reason" "ok","response headers" {},"json body" {"odata context" "https //tatnet ivanti com/api/odata/change/$metadata#changes/$entity","acceptanceduedate" "0001 01 01t00 00 00z","accepttimeout" "0001 01 01t00 00 00z","backoutplanattached"\ false,"ballotcount"\ null,"businessfunction valid" "","businessfunction" "","category valid" "e0234286776b43c39231635c7066f369","category" "software","changenumber" 10173,"closedby"\ null,"closedcode valid" "","closedcode" "","closeddatetime" response headers header description example 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