Ivanti API

(0 reviews)

This API to create or log incident in IVANTI.

Overview:

API to create or log incident in IVANTI.
This API is also used to add and retrieve notes and attachments.

	API Method	REST Endpoint	Description	Consumers
1.	POST	/{version}/create/incident	API to create or log incident in IVANTI. API accepts Request in json format	IVANTI Application
2.	GET	/{version}/categories	Retrieve all categories from Ivanti	IVANTI Application
3.	POST	/{version}/events/incidents	Zendesk Create Incident in Ivanti	IVANTI Application
4.	GET	/{version}/events/incidents/{incidentId}	Retrieve the Incident notes details from Ivanti	IVANTI Application
5.	POST	/{version}/events/incidents/{incidentId}/comments	Adding the Note to the incident	IVANTI Application
6.	GET	/{version}/events/incidents/{incidentId}/emails	Retrieving Incident	IVANTI Application
7.	GET	/{version}/events/incidents/{incidentId}/emails/attachments/{attachmentid}	Retrives ivanti email attachments	IVANTI Application
8.	PATCH	/{version}/incidents/{incidentId}	Link an existing Ivanti incident to a Zendesk ticket	IVANTI Application
9.	POST	/{version}/incidents/{incidentId}/attachments	upload attachments to Incident	IVANTI Application

Integration Architecture:

resources/image-dffcdbe8-6ce2-42fd-95bb-3fca254f11d5.png

1. Flow Diagram and Description:

ca-ivanti-xapi uses the data from ivanti portal and ivanti Web services integrating with ca-ivanti-papi.

resources/ivantiflow.drawio-55a7043e-902e-4fa8-ab8a-4867833335de.png

Sequence Diagram:

resources/image-3734433e-6ef7-469e-9898-f085370d345b.png

Sequence Diagram steps:

No.	Steps	Description
1.	Input Request Message	Ivanti Business service invokes the XAPI layer with Bearer Token.
2	Validate the Bearer credentials	If the token is authorized by the XAPI the request is sent to the endpoint.
3.	If Validation fails, service returns specific fault response	If validation fails, service returns specific fault response to the caller.
4.	If the validation succeeds while calling the Endpoint	A success response is sent to the Endpoint which checks for Zendesk ticket validation.
5.	If Zendesk validation succeeds	The response is sent to Ticket and notes APIs for availability in the Ivanti.
6.	If Ticket Id is available in Ivanti	Add the comments to the Ivanti ticket.
7.	If any validation fails	Return error response to the user.

End Point details:

Check Point Experience API : api/v1/create/incident

	Topic	Details
1.	Operation Description	API to create or log incident in IVANTI.
2.	URI	api/v1/create/incident
3.	Interface Source	Ivanti Application
4.	Interface Target	ca-ivanti-papi
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://sandbox-api.cambridgeassessment.org.uk/qa1/v1/ivanti/api/incident
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Check Point Experience API : api/v1/categories

	Topic	Details
1.	Operation Description	Retrieve all categories from Ivanti
2.	URI	api/v1/categories
3.	Interface Source	Ivanti Application
4.	Interface Target	ca-ivanti-papi
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://sandbox-api.cambridgeassessment.org.uk/qa1/v1/ivanti/api/categories
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Check Point Experience API : api/v2/events/incidents

	Topic	Details
1.	Operation Description	Zendesk Create Incident in Ivanti
2.	URI	api/v2/events/incidents
3.	Interface Source	Ivanti Application
4.	Interface Target	ca-ivanti-papi
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/qa1/v2/ivanti/api/events/incident
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Check Point Experience API : api/v2/events/incidents/{incidentId}

	Topic	Details
1.	Operation Description	Retrieve the Incident notes details from Ivanti
2.	URI	api/v2/events/incidents/{incidentId}
3.	Interface Source	Ivanti Application
4.	Interface Target	ca-ivanti-papi
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/qa1/v2/ivanti/api/incident/908859
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Check Point Experience API : api/v2/events/incidents/{incidentId}/comments

	Topic	Details
1.	Operation Description	Adding the notes to the incident
2.	URI	api/v2/events/incidents/{incidentId}/comments
3.	Interface Source	Ivanti Application
4.	Interface Target	ca-ivanti-papi
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/qa1/v2/ivanti/api/events/incident/855097/comments
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Check Point Experience API : api/v2/events/incidents/{incidentId}/emails

	Topic	Details
1.	Operation Description	Retrieve the Incident
2.	URI	api/v2/events/incidents/{incidentId}/emails
3.	Interface Source	Ivanti Application
4.	Interface Target	ca-ivanti-papi
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/qa1/v2/ivanti/api/incident/908859/emails
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Check Point Experience API : api/v2/events/incidents/{incidentId}/emails/attachments/{attachmentid}

	Topic	Details
1.	Operation Description	retrieves ivanti email attachments
2.	URI	api/v2/events/incidents/{incidentId}/emails/attachments/{attachmentid}
3.	Interface Source	Ivanti Application
4.	Interface Target	ca-ivanti-papi
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/qa1/v2/ivanti/api/events/incident/855097/emails/attachments/1234
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Check Point Experience API : api/v2/incidents/{incidentId}

	Topic	Details
1.	Operation Description	Link an existing Ivanti incident to a Zendesk ticket
2.	URI	api/v2/incidents/{incidentId}
3.	Interface Source	Ivanti Application
4.	Interface Target	ca-ivanti-papi
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/qa1/v2/ivanti/api/incidents/908859
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Check Point Experience API : api/v2/incidents/{incidentId}/attachments

	Topic	Details
1.	Operation Description	upload attachments to incident
2.	URI	api/v2/incidents/{incidentId}/attachments
3.	Interface Source	Ivanti Application
4.	Interface Target	ca-ivanti-papi
5.	Synchronous/Asynchronous	Synchronous
6.	Protocol	HTTPs
7.	URL	https://apis-sandbox.cambridgeassessment.org.uk/qa1/v2/ivanti/api/events/incident/855097/attachments
8.	Mode of Communication	☐ Batch ☐ Message ☒ Real Time
9.	Interface Pattern	☐ Publish / Subscribe ☒ Request / Reply

Error Codes

HTTP Code	Error Code	Error Message
500	60006	Message Not Processed. There is some technical error while processing request. Please report this to Support team.
401	70401	Message Not Processed: Invalid Access token. Please provide valid access token.
401	70402	Message Not Processed: Missing Access token. Please provide valid access token.
401	70405	Message Not Processed: Access token expired. Please try again with valid token.
403	70403	Message Not Processed: Not allowed to access requested resource. Please contact support for the access.
404	70404	Message Not Processed: Requested resource is not found.
503	70503	Message Not Processed: One or more back-end is down. Please try again later.
504	70504	Message Not Processed: Back-end timed out. Please try again later.
400	70400	Either customer Email or customer Network Username should be present in the JSON request.
400	70400	To attach file send both attachment File Name and attachment File Data (Base64Encoded) in the request.
400	ISM_5000	Message is Internal server error. If Attachment file is corrupt.

home

Overview:

Integration Architecture:

End Point details:

Error Codes

Reviews