API Failures

When a failure occurs in the CIC Engine, it creates a ticket in ZenDesk or CIC, depending on how CIC is configured. Specifically, when an API fails, the ticket includes a hyperlink to the CIC Cockpit Job Details view which corresponds to the failed Job.

Additional details are also added to the ticket:

• Response Status Code
• Response Status Message
• Response Payload
• Web Service Provider/Consumer that was initiated
• Source & Target Endpoint
• Trading Partner, if configured.

This information will be available on the failed Job view, Zendesk ticket, and Email notification as well.

The title of the ticket or the subject of the Email notification is also customized so that users can identify the context of the failure.

Job view

Zendesk ticket

E-mail Notification

For larger payloads, the payload is partially displayed in both the email and Zendesk ticket; the full message can be downloaded from the Job view. Users can navigate to the Job view by clicking the View Job button.

In case of unsupported payload content type, the payload can be downloaded as a full message from the Job view. Users can navigate to the Job view by clicking the View Job button.

Note: The above information in the Ticket/Email Notification requires the latest CIC Engine and CIC Studio version (v5.x or later in case of older generation CIC).  These details are only available for tickets generated after February 9th, 2023.

Related Topics

• API Endpoints - Consumer and Provider