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 https //support wm edu/cherwellapi/swagger/ui/index#!/ https //support wm edu/cherwellapi/swagger/ui/index#!/service/service token 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 https //support wm edu/cherwellapi/swagger/ui/index#!/businessobject/businessobject savebusinessobjectv1 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 https //support wm edu/cherwellapi/swagger/ui/index#!/businessobject/businessobject getbusinessobjectbypublicidv1 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 https //support wm edu/cherwellapi/swagger/ui/index#!/businessobject/businessobject getbusinessobjectbyrecidv1 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 {"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"}} 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