CSM 10.4 Documentation

Home

About the Cherwell Canonical REST API

The Cherwell Canonical REST API allows for 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 a the OOTB Incident Business Object by using the Canonical REST API to map from the Incident Schema to the Ticket Schema.

The Canonical REST API is primarily intended for creating reusable integrations between third-party software and customized CSM systems. If you 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.

Was this article useful?