How to print the log for new sn_ws_err.ServiceError(); in scripted rest API?

[Ganeshm1]

Hi All,

Hope you are doing well!

I have configured few scripted rest API and used below method for error logging. When I tried to print the logs in the syslog table, non of the methods are printing these values in the log table. Please let me know if you have any idea on this to print the log. 

var err = new sn_ws_err.ServiceError();
err.setStatus('status');
err.setMessage('message');
err.setDetail('detail');

gs.info(err)
gs.info(JSON.stringify(err));
gs.info(err.toString());

Results: 

x_ej_imac_soluti_0: [object ServiceError]
x_ej_imac_soluti_0: {}
x_ej_imac_soluti_0: [object ServiceError]

ServiceNow doc says we are good to use this method but logging from this method looks like a challenge. 

https://developer.servicenow.com/dev.do#!/learn/learning-plans/xanadu/servicenow_application_develop...

Please let me know your thoughts on this. Thank you!

Best Regards,
Ganesh

[Naveen20]

This helper function approach is the cleanest — it keeps your code DRY and ensures every error is logged consistently:

function createAndLogError(statusCode, msg, detailMsg) {
    gs.error('REST API Error - Status: ' + statusCode 
             + ' | Message: ' + msg 
             + ' | Detail: ' + detailMsg);

    var err = new sn_ws_err.ServiceError();
    err.setStatus(statusCode);
    err.setMessage(msg);
    err.setDetail(detailMsg);
    return err;
}

// Usage
response.setError(createAndLogError(404, 'Record not found', 'No CI found with sys_id: ' + sysId));

One function call handles both logging and error creation, so you never accidentally forget to log an error or end up with mismatched values between your log and your response.

[Tanushree Maiti]

Option 1: Within the code , you can write it 

var errorReported= new sn_ws_err.ServiceError();  //this API used to set the custom error messages
        errorReported.setStatus(this.status);
        errorReported.setMessage(responseObject.body.message);
        errorReported.setDetail(responseObject.body.detail);
        return errorReported;

Option 2: you can create a function with parameter and within the code->after getting response -> call the function

LogError: function(status,detail, message) {

var errorReported = new sn_ws_err.ServiceError();

errorReported.setStatus(status);

errorReported.setDetail(detail);

errorReported.setMessage(message);

return errorReported;

},

Refer : Scripted REST API in ServiceNow Inbound Integration solution with Custom Responses.

Scripted Rest API to add work notes to the Change Request