Canonical REST API Usage and Examples

The Cherwell Canonical REST API supports basic CRUD (create, read, update, and delete) operations on Business Objects and Business Object comments. You can also perform search operations to search for Business Objects. Code samples for the Canonical REST API are available in C#.

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.

Before you begin programming, verify that your system is set up to connect to the Canonical REST API. Refer to Canonical REST API Mapping Wizard for procedural information.

C# code samples for the Canonical REST API are provided on Cherwell's GitHub page in the CanonicalAPI-Samples repository.