Submit User Reviews on Dynamic Rules

Endpoint Name: URL/access/klearstack/submit_user_reviews_on_audit_rules

Request type : POST

Authorization: Bearer token as header

Endpoint Details: The submit_user_reviews_on_audit_rules endpoint will be used to submit user reviews on dynamically generated audit rules.

Method	URL
POST	URL/access/klearstack/submit_user_reviews_on_audit_rules

Request Body

Params	Values	Required	Description
company_name	string	Yes	Name of the company for which the user is logging in
reviews	string	Yes	User review along with decision like 'approved','rejected','approved_and_enabled' Sample Data:[{"rule_id":"6a2aaa034de66a36f6f69ba6","decision":"rejected","comments":"Rejected"},{"rule_id":"6a2aaa034de66a36f6f69ba7","decision":"approved","comments":"Rejected"}]

Shell (cURL)

• Request Body

curl --location "URL/access/klearstack/submit_user_reviews_on_audit_rules" \
  --header "Authorization: Bearer your_token_here" \
  --form "company_name=Replace_Company_Name_Here" \
  --form "reviews=[{'rule_id':'6a2aaa034de66a36f6f69ba6','decision':'rejected','comments':'Rejected'},{'rule_id':'6a2aaa034de66a36f6f69ba7','decision':'approved','comments':'Rejected'}]" \
  

Python

• Request Body

import requests

url = "URL/access/klearstack/submit_user_reviews_on_audit_rules"

payload = {'company_name': 'Replace_Company_Name_Here',
'reviews': '[{\'rule_id\':\'6a2aaa034de66a36f6f69ba6\',\'decision\':\'rejected\',\'comments\':\'Rejected\'},{\'rule_id\':\'6a2aaa034de66a36f6f69ba7\',\'decision\':\'approved\',\'comments\':\'Rejected\'}]'}
files=[

]
headers = {
  'Authorization': 'Bearer your_token_here'
}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)

Java (OkHttp)

• Request Body

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)
  .addFormDataPart("company_name","Replace_Company_Name_Here")
  .addFormDataPart("reviews","[{'rule_id':'6a2aaa034de66a36f6f69ba6','decision':'rejected','comments':'Rejected'},{'rule_id':'6a2aaa034de66a36f6f69ba7','decision':'approved','comments':'Rejected'}]")
  .build();
Request request = new Request.Builder()
  .url("URL/access/klearstack/submit_user_reviews_on_audit_rules")
  .method("POST", body)
  .addHeader("Authorization", "Bearer your_token_here")
  .build();
Response response = client.newCall(request).execute();

Node.js (Axios)

• Request Body

const axios = require('axios');
const FormData = require('form-data');
let data = new FormData();
data.append('company_name', 'Replace_Company_Name_Here');
data.append('reviews', '[{\'rule_id\':\'6a2aaa034de66a36f6f69ba6\',\'decision\':\'rejected\',\'comments\':\'Rejected\'},{\'rule_id\':\'6a2aaa034de66a36f6f69ba7\',\'decision\':\'approved\',\'comments\':\'Rejected\'}]');

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'URL/access/klearstack/submit_user_reviews_on_audit_rules',
  headers: { 
    'Authorization': 'Bearer your_token_here', 
    ...data.getHeaders()
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

JavaScript (XHR)

• Request Body

// WARNING: For POST requests, body is set to null by browsers.
var data = new FormData();
data.append("company_name", "Replace_Company_Name_Here");
data.append("reviews", "[{'rule_id':'6a2aaa034de66a36f6f69ba6','decision':'rejected','comments':'Rejected'},{'rule_id':'6a2aaa034de66a36f6f69ba7','decision':'approved','comments':'Rejected'}]");

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function() {
  if(this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "URL/access/klearstack/submit_user_reviews_on_audit_rules");
xhr.setRequestHeader("Authorization", "Bearer your_token_here");

xhr.send(data);

API Response

Status code	Example Response
200	{ "success": true, "submitted": 1, "matched": 0, "modified": 0, "folder_assignment": { "success": true, "assigned": 0 }, "solution_assignment": { "success": true, "updated_solutions": 0, "updated_rule_links": 0 }, "validation_errors": [] }
400	{"success": False, "message": "Invalid decision value in reviews. Allowed values are: approved, rejected, approved_and_enabled"}
500	{'error': error}
400	{'status': 'fail', 'description': 'Failed to submit reviews'}