Cherwell Service Management Rest

The Cherwell Service Management Rest connector allows for streamlined automation of IT service management tasks by interfacing with Cherwell's ITSM platform.

Cherwell Service Management is a comprehensive IT service management (ITSM) solution that streamlines service delivery and enhances IT workflow efficiency. This connector enables Swimlane Turbine users to automate ITSM processes by creating, updating, and retrieving Cherwell Business Objects directly within the Swimlane platform. By integrating with Cherwell Service Management Rest, users can leverage real-time data synchronization, incident management, and service request fulfillment, enhancing their security automation and response capabilities.

Limitations

None to date.

Supported Versions

This Cherwell Service Management Rest connector uses the Version 1 API.

Additional Docs

API Documentation

Authentication

Configuration

Prerequisites

To utilize the Cherwell Service Management Rest connector, you must have the following:

Cherwell Service Management authentication credentials, which include:

URL: The endpoint URL for the Cherwell Service Management API.

Cherwell Client ID: The unique identifier for your Cherwell application.

Grant Type: The OAuth grant type used for obtaining the necessary tokens.

Create or Update a Business Object

Operation that creates a new Business Object or updates an existing Business Object. To create, leave record ID and public ID empty. Upon creating or saving, a cache key is returned to use for subsequent requests Link.

Get a business Object Record by Public ID

This action returns a Business Object record that includes a list of fields and their record IDs, names, and set values Link.

Get a Business Object record

This action returns a Business Object record that includes a list of fields and their record IDs, names, and set values Link.

Configurations

Cherwell Service Management Rest

Cherwell Service Management authenticates using Client ID, Client Secret, Username, Password, Refresh Token.

Configuration Parameters

Parameter	Description	Type	Required
url	A URL to the target host.	string	Required
cherwell_client_id	The API client key for the client making the token request.	string	Required
cherwell_client_secret	The API client secret for the native client making the token request. This is only required for native clients.	string	Optional
grant_type	The type of grant being requested values - password or refresh_token.	string	Required
cherwell_username	Specify the login ID for the CSM user who will be granted the access token.	string	Optional
cherwell_password	Specify the password assigned to the login ID.	string	Optional
refresh_token	Specify the refresh token used to grant another access token.	string	Optional
auth_mode	Specify the Authentication Mode to use for requesting an access token.	string	Optional
site_name	If for portal specify the Site name to use for requesting an access token.	string	Optional
verify_ssl	Verify SSL certificate	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

Actions

Create or Update a Business Object

Creates or updates a Cherwell Business Object, returning a cache key for further interactions. Ensure record and public IDs are empty to create.

Endpoint

URL: CherwellAPI/api/V1/savebusinessobject

Method: POST

Input

Argument Name	Type	Required	Description
parameters.lang	string	Optional	Optional parameter to specify the culture of the request. Either "lang" or "locale" can be used to specify the culture.
parameters.locale	string	Optional	Optional parameter to specify the culture of the request. Either "lang" or "locale" can be used to specify the culture.
busObId	string	Optional	Unique identifier
busObPublicId	string	Optional	Unique identifier
busObRecId	string	Optional	Unique identifier
cacheKey	string	Optional	Parameter for Create or Update a Business Object
cacheScope	string	Optional	Parameter for Create or Update a Business Object
fields	array	Optional	Parameter for Create or Update a Business Object
fields.dirty	boolean	Optional	Parameter for Create or Update a Business Object
fields.displayName	string	Optional	Name of the resource
fields.fieldId	string	Optional	Unique identifier
fields.fullFieldId	string	Optional	Unique identifier
fields.html	string	Optional	Parameter for Create or Update a Business Object
fields.name	string	Optional	Name of the resource
fields.value	string	Optional	Value for the parameter
persist	boolean	Optional	Parameter for Create or Update a Business Object

Input Example

{"parameters":{"lang":"dsfg34345","locale":"dsf34esdf"},"json_body":{"busObId":"busobjectid","busObPublicId":"busObjectPublicId","busObRecId":"busObjectRecId","cacheKey":"CacheKeyExample","cacheScope":"CacheScopeExample","fields":[{"dirty":true,"displayName":"displayName","fieldId":"fieldId","fullFieldId":"fullFieldId","html":"html_example","name":"name_example","value":"value_example"}],"persist":true}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
busObPublicId	string	Unique identifier
busObRecId	string	Unique identifier
cacheKey	string	Output field: cacheKey
fieldValidationErrors	array	Unique identifier
fieldValidationErrors.error	string	Unique identifier
fieldValidationErrors.errorCode	string	Unique identifier
fieldValidationErrors.fieldId	string	Unique identifier
notificationTriggers	array	Output field: notificationTriggers
notificationTriggers.sourceType	string	Type of the resource
notificationTriggers.sourceId	string	Unique identifier
notificationTriggers.sourceChange	string	Output field: notificationTriggers.sourceChange
notificationTriggers.key	string	Output field: notificationTriggers.key
errorCode	string	Error message if any
errorMessage	string	Response message
hasError	boolean	Error message if any
httpStatusCode	string	Status value

Output Example

{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"busObPublicId":"string","busObRecId":"string","cacheKey":"string","fieldValidationErrors":[{}],"notificationTriggers":[{}],"errorCode":"string","errorMessage":"string","hasError":true,"httpStatusCode":"Continue"}}

Get a Business Object Record

Retrieves a specific Business Object record from Cherwell Service Management using the provided object and record IDs.

Endpoint

URL: CherwellAPI/api/V1/getbusinessobject/busobid/{{busobid}}/busobrecid/{{busobrecid}}

Method: GET

Input

Argument Name	Type	Required	Description
parameters.lang	string	Optional	Parameters for the Get a Business Object Record action
parameters.locale	string	Optional	Parameters for the Get a Business Object Record action
path_parameters.busobid	string	Required	Specify the Business Object ID.
path_parameters.busobrecid	string	Required	Specify the Business Object Record ID.

Input Example

{"parameters":{"lang":"wertsas","locale":"qweqwe2345qw"},"path_parameters":{"busobid":"dadsfs","busobrecid":"34564wesdfgdzxc"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
busObId	string	Unique identifier
busObPublicId	string	Unique identifier
busObRecId	string	Unique identifier
fields	array	Output field: fields
fields.dirty	boolean	Output field: fields.dirty
fields.displayName	string	Name of the resource
fields.fieldId	string	Unique identifier
fields.fullFieldId	string	Unique identifier
fields.html	string	Output field: fields.html
fields.name	string	Name of the resource
fields.value	string	Value for the parameter
links	array	Output field: links
links.name	string	Name of the resource
links.url	string	URL endpoint for the request
errorCode	string	Error message if any
errorMessage	string	Response message
hasError	boolean	Error message if any
httpStatusCode	string	Status value

Output Example

{"status_code":200,"response_headers":{},"reason":"OK","json_body":{"busObId":"string","busObPublicId":"string","busObRecId":"string","fields":[{}],"links":[{}],"errorCode":"string","errorMessage":"string","hasError":true,"httpStatusCode":"Continue"}}

Get a Business Object Record by Public ID

Retrieves a specific Business Object record by its public ID in Cherwell Service Management, including field IDs, names, and values.

Endpoint

URL: CherwellAPI/api/V1/getbusinessobject/busobid/{{busobid}}/publicid/{{publicid}}

Method: GET

Input

Argument Name	Type	Required	Description
parameters.lang	string	Optional	Parameters for the Get a Business Object Record by Public ID action
parameters.locale	string	Optional	Parameters for the Get a Business Object Record by Public ID action
path_parameters.busobid	string	Required	Specify the Business Object ID.
path_parameters.publicid	string	Required	Specify the Business Object record ID.

Input Example

{"parameters":{"lang":"example_lang","locale":"example_locale"},"path_parameters":{"busobid":"eewr23452","publicid":"werdfg2345ewasdf"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
busObId	string	Unique identifier
busObPublicId	string	Unique identifier
busObRecId	string	Unique identifier
fields	array	Output field: fields
fields.dirty	boolean	Output field: fields.dirty
fields.displayName	string	Name of the resource
fields.fieldId	string	Unique identifier
fields.fullFieldId	string	Unique identifier
fields.html	string	Output field: fields.html
fields.name	string	Name of the resource
fields.value	string	Value for the parameter
links	array	Output field: links
links.name	string	Name of the resource
links.url	string	URL endpoint for the request
errorCode	string	Error message if any
errorMessage	string	Response message
hasError	boolean	Error message if any
httpStatusCode	string	Status value

Output Example

Response Headers

Header	Description	Example
Content-Type	The media type of the resource	application/json
Date	The date and time at which the message was originated	Thu, 01 Jan 2024 00:00:00 GMT