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 Ivanti Documentation.
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 |