question Re: REST Script API giving bad json format error in Developer forum

REST Script API giving bad json format error

booher04 — Fri, 21 Mar 2025 13:39:00 GMT

REST API Call to 3rd party(AlgoSec) is giving BAD JSON Format response in ECC Queue:

The format I was told to use is one I'm unfamiliar with, however when trying to use their format I get the same JSON error. In the content section of the HTTP Method:

{ "template": "Standard", "requestor":"${requestor}", "change_request_justification":"${change_request_justification}", "external_change_request":"${external_change_request}", "traffic": [{ "source": {"items": [{ "name": ""}] }, "destination": {"items": [{ "name": "}] }, "service": {"items": [{"name": "" }] }, "action": "Allow", "application": {"items": [{"name": ""}]} }] }

"Traffic" seems to be the equivalent to a MRVS we have in SNOW to pass over to AlgoSec.

Here is the Run Script POST in my workflow:

try { var r = new sn_ws.RESTMessageV2('AlgoSec', 'AlgoSec POST'); r.setRequestHeader('Cookie',current.variables.sessionid.toString()); r.setStringParameterNoEscape('template', 'Standard'); r.setStringParameterNoEscape('requestor', current.variables.requester_name.getDisplayValue()); r.setStringParameterNoEscape('change request justification',current.variables.chg_justification); r.setStringParameterNoEscape('external change request id', current.number); r.setStringParameterNoEscape('traffic', current.variables.access_request_detail); r.setStringParameterNoEscape('action', 'Allow'); var response = r.execute(); var responseBody = response.getBody(); var httpStatus = response.getStatusCode(); } catch(ex) { var message = ex.message; } current.variables.xml_response = responseBody;

I authenticate correctly, then the POST happens and I get the below back in the ECC queue input:

<results error="Method failed: (/FireFlow/api/change-requests/traffic) with code: 400" probe_time="209" result_code="900000"> <result error="Method failed: (/FireFlow/api/change-requests/traffic) with code: 400"> <output>{"status":"Failure","messages":[{"code":"BAD_JSON_FORMAT","message":"Bad JSON format: failed to parse request body"}],"data":null}</output> </result>

Response content:

"content" value="{ "template": "Standard", "requestor":"Jeffrey Booher", "change_request_justification":"", "external_change_request":"", "traffic": [{ "source": {"items": [{ "name": ""}] }, "destination": {"items": [{ "name": "}] }, "service": {"items": [{"name": "" }] }, "action": "Allow", "application": {"items": [{"name": ""}]} }] }"/>

I'm assuming the format I'm using in the Content of the HTTP Method and the Run Script POST in the workflow are not formatted correctly, so any pointers would be great.

Typically when passing MRVs I use "name_of_mrvs":${name_of_mrvs} and the variables I use "name_of_var":"${name_of_var}",

Re: REST Script API giving bad json format error

Shivalika — Fri, 21 Mar 2025 14:33:33 GMT

Hello @booher04

Please try below Json -

{

"template": "Standard",

"requestor": "${requestor}",

"change_request_justification": "${change_request_justification}",

"external_change_request": "${external_change_request}",

"traffic": [

{

"source": {

"items": [

{

"name": ""

}

]

"destination": {

"items": [

{

"name": ""

}

]

"service": {

"items": [

{

"name": ""

}

]

"action": "Allow",

"application": {

"items": [

{

"name": ""

}

]

}

]

}

Kindly mark my answer as helpful and accept solution if it helped you in anyway. This will help me be recognized for the efforts and also move this questions from unsolved to solved bucket.

Regards,

Shivalika

My LinkedIn - https://www.linkedin.com/in/shivalika-gupta-540346194

My youtube - https://youtube.com/playlist?list=PLsHuNzTdkE5Cn4PyS7HdV0Vg8JsfdgQlA&si=0WynLcOwNeEISQCY

Re: REST Script API giving bad json format error

Shivalika — Fri, 21 Mar 2025 14:35:27 GMT

Hello @booher04

A better way to view it -

{
"template": "Standard",
"requestor":"${requestor}",
"change_request_justification":"${change_request_justification}",
"external_change_request":"${external_change_request}",
"traffic": [{ "source": {"items": [{ "name": ""}] },
"destination": {"items": [{ "name": ""}] },
"service": {"items": [{"name": "" }] },
"action": "Allow",
"application": {"items": [{"name": ""}]} }]
}

Kindly mark my answer as helpful and accept solution if it helped you in anyway. This will help me be recognized for the efforts and also move this questions from unsolved to solved bucket.

Regards,

Shivalika

My LinkedIn - https://www.linkedin.com/in/shivalika-gupta-540346194

My youtube - https://youtube.com/playlist?list=PLsHuNzTdkE5Cn4PyS7HdV0Vg8JsfdgQlA&si=0WynLcOwNeEISQCY

Re: REST Script API giving bad json format error

booher04 — Fri, 21 Mar 2025 14:42:54 GMT

Hello - thanks for the response. I get the same error message when using what you provided.

Re: REST Script API giving bad json format error

Ankur Bawiskar — Fri, 21 Mar 2025 14:44:34 GMT

@booher04

are you sure you are sending the MRVS data in that JSON correctly as per what they expect?

what came in the request body?

try { 
 var r = new sn_ws.RESTMessageV2('AlgoSec', 'AlgoSec POST');
 r.setRequestHeader('Cookie',current.variables.sessionid.toString());
 
 r.setStringParameterNoEscape('template', 'Standard');
 r.setStringParameterNoEscape('requestor', current.variables.requester_name.getDisplayValue());
 r.setStringParameterNoEscape('change request justification',current.variables.chg_justification);
 r.setStringParameterNoEscape('external change request id', current.number);
 r.setStringParameterNoEscape('traffic', current.variables.access_request_detail);
 r.setStringParameterNoEscape('action', 'Allow');

 var response = r.execute();
 gs.info('Request body' + r.getRequestBody());
 var responseBody = response.getBody();
 var httpStatus = response.getStatusCode();
}
catch(ex) {
 var message = ex.message;
}

current.variables.xml_response = responseBody;

If my response helped please mark it correct and close the thread so that it benefits future readers.

Re: REST Script API giving bad json format error

Shivalika — Fri, 21 Mar 2025 14:50:28 GMT

Hello @booher04

Try below with above -

try {

var r = new sn_ws.RESTMessageV2('AlgoSec', 'AlgoSec POST');

// Set request header

r.setRequestHeader('Cookie', current.variables.sessionid.toString());

// Ensure parameter names match API expectations

r.setStringParameterNoEscape('template', 'Standard');

// Check if requester_name is a reference field before using getDisplayValue()

var requesterName = current.variables.requester_name ? current.variables.requester_name.getDisplayValue() : '';

r.setStringParameterNoEscape('requestor', requesterName);

r.setStringParameterNoEscape('change_request_justification', current.variables.chg_justification);

r.setStringParameterNoEscape('external_change_request_id', current.number);

r.setStringParameterNoEscape('traffic', current.variables.access_request_detail);

r.setStringParameterNoEscape('action', 'Allow');

var response = r.execute();

var responseBody = response.getBody();

var httpStatus = response.getStatusCode();

// Log for debugging

gs.info("AlgoSec API Response: " + responseBody);

gs.info("AlgoSec API HTTP Status: " + httpStatus);

}

catch(ex) {

var message = ex.message;

gs.error("AlgoSec API Error: " + message);

var responseBody = "Error: " + message; // Ensure responseBody is always defined

}

// Store response in a variable for later use

current.variables.xml_response = responseBody;

Kindly mark my answer as helpful and accept solution if it helped you in anyway. This will help me be recognized for the efforts and also move this questions from unsolved to solved bucket.

Regards,

Shivalika

My LinkedIn - https://www.linkedin.com/in/shivalika-gupta-540346194

My youtube - https://youtube.com/playlist?list=PLsHuNzTdkE5Cn4PyS7HdV0Vg8JsfdgQlA&si=0WynLcOwNeEISQCY

Re: REST Script API giving bad json format error

booher04 — Fri, 21 Mar 2025 15:06:36 GMT

03-21-2025 11:04:04 AM	system	Information	AlgoSec API HTTP Status: 400	*** Script
Select record for action: Created 03-21-2025 11:04:04 AM		03-21-2025 11:04:04 AM	system	Information	AlgoSec API Response: {"status":"Failure","messages":[{"code":"BAD_JSON_FORMAT","message":"Bad JSON format: failed to parse request body"}],"data":null}

Re: REST Script API giving bad json format error

Shivalika — Fri, 21 Mar 2025 15:09:22 GMT

Hello @booher04

In that case, are you sure that the field names that you have passed in the json are correct ? There is no naming convention error ?

Also the header Content is set to Application/Json ? Accept also set to same ?

Kindly mark my answer as helpful and accept solution if it helped you in anyway. This will help me be recognized for the efforts and also move this questions from unsolved to solved bucket.

Regards,

Shivalika

My LinkedIn - https://www.linkedin.com/in/shivalika-gupta-540346194

My youtube - https://youtube.com/playlist?list=PLsHuNzTdkE5Cn4PyS7HdV0Vg8JsfdgQlA&si=0WynLcOwNeEISQCY

Re: REST Script API giving bad json format error

booher04 — Fri, 21 Mar 2025 15:11:14 GMT

Request body{
"template": "Standard",
"requestor":"Jeffrey Booher",
"change_request_justification":"",
"external_change_request":"",
"traffic": [{ "source": {"items": [{ "name": ""}] },
"destination": {"items": [{ "name": ""}] },
"service": {"items": [{"name": "" }] },
"action": "Allow",
"application": {"items": [{"name": ""}]} }]
}

Re: REST Script API giving bad json format error

booher04 — Fri, 21 Mar 2025 15:17:30 GMT

I removed the 2 fields that would be outside of the MRVs(except for requestor because it's working). I got the below input from AlgoSec in ECC:

<results error="Method failed: (/FireFlow/api/change-requests/traffic) with code: 400" probe_time="482" result_code="900000"> <result error="Method failed: (/FireFlow/api/change-requests/traffic) with code: 400"> <output>{"status":"Failure","messages":[{"code":"INVALID_VALUE_FOR_FIELD_IN_LINE","message":"source field contains invalid value(s): Null (traffic line 1)"},{"code":"INVALID_VALUE_FOR_FIELD_IN_LINE","message":"destination field contains invalid value(s): Null (traffic line 1)"},{"code":"INVALID_VALUE_FOR_FIELD_IN_LINE","message":"service field contains invalid value(s): Null (traffic line 1)"},{"code":"INVALID_VALUE_FOR_FIELD_IN_LINE","message":"application field contains invalid value(s): Null (traffic line 1)"}],"data":null}</output> </result>

Re: REST Script API giving bad json format error

Shivalika — Fri, 21 Mar 2025 15:26:13 GMT

Hello @booher04

It means, you are passing some values to choice field or reference fields which do not already exist on your table.

Please cross check all the field names and values that you are passing. Everything should be valid and correct. Along with the script already provided above.

Kindly mark my answer as helpful and accept solution if it helped you in anyway. This will help me be recognized for the efforts and also move this questions from unsolved to solved bucket.

Regards,

Shivalika

My LinkedIn - https://www.linkedin.com/in/shivalika-gupta-540346194

My youtube - https://youtube.com/playlist?list=PLsHuNzTdkE5Cn4PyS7HdV0Vg8JsfdgQlA&si=0WynLcOwNeEISQCY

Re: REST Script API giving bad json format error

booher04 — Mon, 24 Mar 2025 14:45:03 GMT

Content format they require:

{ "template": "Standard", "traffic": [ { "source": { "items": [ { "address": "${source}" } ] }, "destination": { "items": [ { "address": "${destination}" } ] }, "service": { "items": [ { "address": "${service}" } ] }, "application": { "items": [ { "name": "${application}" } ] }, "action": "Allow" } ] }

Here's my POST in the workflow:

try { var r = new sn_ws.RESTMessageV2('AlgoSec', 'AlgoSec POST'); r.setRequestHeader('Cookie',current.variables.sessionid.toString()); r.setStringParameterNoEscape('template', 'Standard'); //r.setStringParameterNoEscape('traffic', current.variables.access_request_detail); //r.setStringParameterNoEscape('action', 'Allow'); r.setStringParameterNoEscape('service', current.variables.access_request_detail.destination_tcp_port); r.setStringParameterNoEscape('application', current.variables.application_variable.getDisplayValue()); r.setStringParameterNoEscape('source',current.variables.access_request_detail.source_ip_address_es); r.setStringParameterNoEscape('destination', current.variables.access_request_detail.destination_ip_address_es); //r.setStringParameterNoEscape('content',global.JSON.stringify(jsonObj)); var response = r.execute(); gs.info('Request body' + r.getRequestBody()); var responseBody = response.getBody(); var httpStatus = response.getStatusCode(); } catch(ex) { var message = ex.message; } current.variables.xml_response = responseBody;

Here's the error I receive now:

<result error="Method failed: (/FireFlow/api/change-requests/traffic) with code: 400"> <output>{"status":"Failure","messages":[{"code":"INVALID_VALUE_FOR_FIELD_IN_LINE","message":"source field contains invalid value(s): [[1.1.1.12]] (traffic line 1)"},{"code":"INVALID_VALUE_FOR_FIELD_IN_LINE","message":"destination field contains invalid value(s): [[2.2.2.2]] (traffic line 1)"},{"code":"INVALID_VALUE_FOR_FIELD_IN_LINE","message":"service field contains invalid value(s): [[22]] (traffic line 1)"},{"code":"INVALID_VALUE_FOR_FIELD_IN_LINE","message":"application field contains invalid value(s): [Accounting Imaging [UAT]] (traffic line 1)"}],"data":null}</output> </result>

Re: REST Script API giving bad json format error

booher04 — Mon, 24 Mar 2025 14:54:58 GMT

Request body{
"template": "Standard",

"traffic": [
{
"source": {
"items": [
{
"address": "[10.0.0.2]"
}
]
},
"destination": {
"items": [
{
"address": "[10.0.0.5]"
}
]
},
"service": {
"items": [
{
"address": "[22]"
}
]
},
"application": {
"items": [
{
"name": "1Password - CINC [Integration]"
}
]
},

"action": "Allow"
}
]
}

Re: REST Script API giving bad json format error

booher04 — Tue, 25 Mar 2025 13:14:45 GMT

@Shivalika

So It looks like the issue is being caused by the MRVs. It's passing the values but putting them in [ ]. I need to pass the values without the [ ] around them. I assume I'd need to somehow convert them to JSON and then pass the variables? Below you can see "22" is inside brackets and I need that to pass without the brackets.

"service": { "items": [ { "address": "[22]" } ] },

try { var r = new sn_ws.RESTMessageV2('AlgoSec', 'AlgoSec POST'); r.setRequestHeader('Cookie',current.variables.sessionid.toString()); r.setStringParameterNoEscape('service', current.variables.access_request_detail.destination_tcp_port); r.setStringParameterNoEscape('application', "any"); r.setStringParameterNoEscape('source',current.variables.access_request_detail.source_ip_address_es); r.setStringParameterNoEscape('destination', current.variables.access_request_detail.destination_ip_address_es); var response = r.execute(); gs.info('Request body' + r.getRequestBody()); var responseBody = response.getBody(); var httpStatus = response.getStatusCode(); }

Re: REST Script API giving bad json format error

Shivalika — Tue, 25 Mar 2025 13:21:09 GMT

Hello @booher04

I can very well see them as json objects only. See there is service json object and within it there is an array and within array another json object.

So you are saying you didn't intend it to pass that way and still it somehow passed like that?

Kindly mark my answer as helpful and accept solution if it helped you in anyway. This will help me be recognized for the efforts and also move this questions from unsolved to solved bucket.

Regards,

Shivalika

My LinkedIn - https://www.linkedin.com/in/shivalika-gupta-540346194

My youtube - https://youtube.com/playlist?list=PLsHuNzTdkE5Cn4PyS7HdV0Vg8JsfdgQlA&si=0WynLcOwNeEISQCY

Re: REST Script API giving bad json format error

booher04 — Tue, 25 Mar 2025 13:25:46 GMT

Our 3rd party vendor explained that the [ ] are the reason the POST is returning an invalid value. I believe it's being passed that way because it's within a MRVs? I created test variables outside of the MRVs and they passed without issue however, the customer explained they need it within a MRVs because of needing to send multiple records at a time.

Re: REST Script API giving bad json format error

Shivalika — Tue, 25 Mar 2025 13:33:10 GMT

Hello @booher04

Actually the reason is valid, it will throw errors when getting array instead of json. So, now I am getting, the story here is they are having only JSON objects to be acceptable and since you are using MRVS, you are intending to post multiple records at one time which isn't feasible. There POST method is only made to take singular json objects.

This is similar to the query I answered yesterday on community. So what you can do is using for loop in your MRVS array and keep separating the json objects and then calling the post method in REST Message V2 function .

Yes, that would work.

Kindly mark my answer as helpful and accept solution if it helped you in anyway. This will help me be recognized for the efforts and also move this questions from unsolved to solved bucket.

Regards,

Shivalika

My LinkedIn - https://www.linkedin.com/in/shivalika-gupta-540346194

My youtube - https://youtube.com/playlist?list=PLsHuNzTdkE5Cn4PyS7HdV0Vg8JsfdgQlA&si=0WynLcOwNeEISQCY

Re: REST Script API giving bad json format error

booher04 — Tue, 25 Mar 2025 14:57:59 GMT

So, I got this setup and it's sending correctly, however it's not sending multiple rows if I add 2 or more to the MRVs. Any idea what I am missing on this?

Re: REST Script API giving bad json format error

Shivalika — Tue, 25 Mar 2025 15:14:03 GMT

Hello @booher04

It's because you are calling the rest message function outside the loop. It's having only first initialized value, that's why working for only one.

Please use below 👇 script -

var mrvs = current.variables.access_request_detail;
var rowCount = mrvs.getRowCount();

// Function to send REST request
function sendRestRequest(dest, sourceIp, destIp) {
try {
var r = new sn_ws.RESTMessageV2('AlgoSec', 'AlgoSec POST');
r.setRequestHeader('Cookie', current.variables.sessionid.toString());

r.setStringParameterNoEscape('service', dest);
r.setStringParameterNoEscape('application', "any");
r.setStringParameterNoEscape('source', sourceIp);
r.setStringParameterNoEscape('destination', destIp);

var response = r.execute();
gs.info('Request body: ' + r.getRequestBody());

return response.getBody();
} catch (ex) {
gs.error('REST request failed: ' + ex.message);
return null;
}
}

// Loop through the MRVS contents
var responseBody = '';
for (var i = 0; i < rowCount; i++) {
var row = mrvs.getRow(i);
var dest = row.destination_tcp_port;
var sourceIp = row.source_ip_address_es;
var destIp = row.destination_ip_address_es;

responseBody = sendRestRequest(dest, sourceIp, destIp);
}

// Store the last response in the variable
current.variables.xml_response = responseBody;

Kindly mark my answer as helpful and accept solution if it helped you in anyway. This will help me be recognized for the efforts and also move this questions from unsolved to solved bucket.

Regards,

Shivalika

My LinkedIn - https://www.linkedin.com/in/shivalika-gupta-540346194

My youtube - https://youtube.com/playlist?list=PLsHuNzTdkE5Cn4PyS7HdV0Vg8JsfdgQlA&si=0WynLcOwNeEISQCY

Re: REST Script API giving bad json format error

Shivalika — Tue, 25 Mar 2025 15:18:23 GMT

Hello @booher04

One more thing rhe xml.response variable in this case will only store the last response, so you might use list - if you want to store all the responses.

If you want this update you can let me know.

Kindly mark my answer as helpful and accept solution if it helped you in anyway. This will help me be recognized for the efforts and also move this questions from unsolved to solved bucket.

Regards,

Shivalika

My LinkedIn - https://www.linkedin.com/in/shivalika-gupta-540346194

My youtube - https://youtube.com/playlist?list=PLsHuNzTdkE5Cn4PyS7HdV0Vg8JsfdgQlA&si=0WynLcOwNeEISQCY