API URL for a Saved Search

The REST API URL for a Saved Search can be used with third-party reporting tools.

You can generate URLs for Saved Searches from the Search Manager in the CSM Desktop Client and the CSM Browser Client.

The API URL for a Saved Search can be copied/created in the following ways:
  • In the CSM Desktop Client, open the Search Manager. Select a Saved Search. Right-click and select Copy API URL to clipboard. From the Search Manager toolbar, you can also select Searches > Copy API URL to clipboard.
  • In the CSM Browser Client, open the Search Manager. Select a Saved Search and select the Copy API URL to clipboard icon .
    The options to Copy API URL to clipboard will not be available if the base API URL was not set.
  • You can manually create the API URL by using one of the following formats:
    • For Global searches:

      https://[Cherwell REST API server]/api/V1/storedsearches/Global/[associated Business Object name]/[Search name]

    • For searches in other scopes:

      https://[Cherwell REST API server]/api/V1/storedsearches/[scope name] (Example: User)/[associated Business Object name]/[Search name]/?scopeOwner=[GUID for owning identity] (Example: the GUID for the User that created the search when scope is User)