• About Cherwell REST APIs
  • About the Cherwell Canonical REST API
    • Map a Canonical Business Object to a Custom Business Object
    • Map Comments to a Custom Business Object
    • Run a Health Check for Canonical Compliance
      • Interpreting the Results of a Canonical Compliance Health Check
    • Canonical REST API Usage and Examples
  • Opening the REST API Discovery Tool
    • Practice Using the REST API Discovery Tool
      • Practice Exercise: Get Search Items
      • Practice Exercise: Get Business Object Schema
      • Practice Exercise: Get Quick Search Configuration for Business Objects
      • Practice Exercise: Save User
  • Securing the REST API
    • OAuth2 Protocol for the REST API
      • Obtaining API Client IDs
    • OAuth2 Authentication Modes
      • Authenticating Using the Internal Mode
      • Authenticating Using the Client-Based Windows/LDAP Mode
      • Authenticating Using the Windows/LDAP Mode With Entered Credentials
      • Requesting a Refresh Token
    • SAML Protocol for the REST API
      • Configuring the REST API for SAML Authentication
      • Client Example: No Final URI
      • Client Example: With Final URI
  • Usage and Examples
    • Business Object Usage and Examples
      • C# Example: Get an Incident
      • PowerShell Example: Get an Incident
      • C# Example: Create an Incident
      • PowerShell Example: Create an Incident
      • C# Example: Upload Attachments
      • PowerShell Example: Upload Attachments
      • C# Example: Delete a Business Object
      • PowerShell Example: Delete A Business Object
    • Using Search Operations
      • C# Example: Get Search Items
      • PowerShell Example: Get Search Items
      • C# Example: Perform an Ad-hoc Search with Filter
      • PowerShell Example: Perform an Ad-hoc Search with Filter
      • C# Example: Perform an Ad-hoc Search with Sorting
      • PowerShell Example: Perform an Ad-hoc Search with Sorting
    • Security Usage and Examples
      • C# Example: Create a User
      • PowerShell Example: Create a User
  • Operation Versioning
  • Errors
  • Using Swagger Code Generation
  • Parameter Glossary
  • Copyright