About Cherwell REST APIs
- Finding, creating, and updating Business Objects
- Finding and running Search queries
- Managing Users
- Getting Mobile Forms
The REST API Discovery Tool provides comprehensive API documentation with an intuitive user interface that enables you to discover and test operations using your CSM data. Testing is available for all authentication modes, except SAML.
REST API Revision History
CSM Version | Changes |
---|---|
9.4.0 |
Added Named Object Operations to perform basic functions against Business Objects via the Cherwell REST API. Named Object Operations include nine API operations with simplified URL paths to provide user-friendly, programmatic access to basic CSM functions. You may want to use the Named Object Operations if you are new to the Cherwell REST API or you do not have extensive programming experience. Functions that you can perform using the Named Object Operations include:
Added 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. |
9.3.0 |
Minor bug fixes. |
9.2.0 |
Added operations for:
In addition, added multiple Powershell examples to the documentation. Expanded information about using OAuth2 and SAML protocols with the REST API. Added SAML client examples with and without a final URI query string. Added practice exercises for using the REST API Discovery Tool. Reorganized the Operations List to match Swagger by adding new categories for Team Operations, User Operations, and Queue Operations. Added instructions for re-generating Swagger code with the new categories after upgrading. |
9.1.0 |
Added operations for:
In addition, added support for HTML content in Business Object fields. |
9.0.1 |
Added multiple C# examples to the documentation. |
8.3.1 |
Added v2 of most Security operations to change Error property to ErrorMessage. Added v3 of getuserbyloginid to change Error property to ErrorMessage. |
8.2.1 |
Added operations for:
Improved Landing Page that includes parameter glossary and Swagger code-gen instructions. |
8.1.1 |
Added v2 of getuserbyloginid. Changed API version to match CSM version. |
8.1.0 |
Support for Windows, LDAP, and SAML authentication. Attachment management and built-in image retrieval operations added. |
8.00 |
Initial Release. |