About the Cherwell Canonical REST API

The Cherwell Canonical REST API enables customers and partners to create reusable integrations between third-party software and customized CSM systems by providing a fixed schema to map out-of-the-box Business Objects to customized Business Objects.

For example, for a system with a custom Business Object called Ticket, you can leverage an integration with the out-of-the-box, or canonical, Business Object Incident by using the Canonical REST API to map from the Incident Schema to the Ticket Schema.

The Canonical REST API is primarily intended for customers and vendors to create reusable integrations between third-party software and customized CSM systems. If you are a Cherwell Administrator and need to integrate with your instance of CSM, we recommend beginning with the Named Object Operations.

Important: To ensure standardization, canonical definitions are supplied and managed by Cherwell. You can access canonical definitions in the Canonical Definitions Manager, but we strongly advise against creating, editing, or deleting canonical definitions as you may inadvertently impact your system's integration capabilities.