Back to Cherwell Integrations
Handler · Version 1

Cherwell Object Retrieve

Download GitHub

About

This handler generically retrieves a Cherwell object and returns a JSON representation of the found object. Execution starts by retrieving an Access Token from Cherwell using the client id/secret and username/password info values. Once that is successfully retrieved, the Object Name is translated into a Business Object Id by using the /getbusinessobjectsummary endpoint. The returned Business Object Id and inputted Object Id are then passed to the /getbusinessobject endpoint to retrieve the full matching object. Lastly, the fields return are converted from an array to a simplified map of field information in the form of {displayName: value}.

Parameters
Name Description Sample
Error Handling Determine what to return if an error is encountered. Error Message
Object Name Readable name of the object to retrieve (ie. Incident). Incident
Object Id Id of the object to be retrieved. 47285
Results
Name Description
Handler Error Message Error message if an error was encountered and Error Handling is set to "Error Message".
Object JSON A JSON representation of the object that matches the id.
Changelog

Cherwell Object Retrieve V1 (2019-11-13)

  • Added auth mode to info values

Cherwell Object Retrieve V1 (2019-11-9)

  • Added error message Handling

Cherwell Object Retrieve V1 (2018-02-14)

  • Initial version. See README for details.
Download GitHub

On This Page

Looking for a workflow engine? Learn more about the Kinetic Data Enterprise Workflow Platform. Check it out
Return to Top