Add an assessment comment
curl --request POST \
--url https://api.gominerva.com/risk-assessments/v2/assessments/{assessmentId}/comments \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"markdown": "<string>",
"subject_id": "<string>",
"canvas_id": "<string>",
"canvas_object_id": "<string>",
"canvas_object_kind": "<string>",
"canvas_object_label": "<string>"
}
'import requests
url = "https://api.gominerva.com/risk-assessments/v2/assessments/{assessmentId}/comments"
payload = {
"markdown": "<string>",
"subject_id": "<string>",
"canvas_id": "<string>",
"canvas_object_id": "<string>",
"canvas_object_kind": "<string>",
"canvas_object_label": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
markdown: '<string>',
subject_id: '<string>',
canvas_id: '<string>',
canvas_object_id: '<string>',
canvas_object_kind: '<string>',
canvas_object_label: '<string>'
})
};
fetch('https://api.gominerva.com/risk-assessments/v2/assessments/{assessmentId}/comments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gominerva.com/risk-assessments/v2/assessments/{assessmentId}/comments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'markdown' => '<string>',
'subject_id' => '<string>',
'canvas_id' => '<string>',
'canvas_object_id' => '<string>',
'canvas_object_kind' => '<string>',
'canvas_object_label' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gominerva.com/risk-assessments/v2/assessments/{assessmentId}/comments"
payload := strings.NewReader("{\n \"markdown\": \"<string>\",\n \"subject_id\": \"<string>\",\n \"canvas_id\": \"<string>\",\n \"canvas_object_id\": \"<string>\",\n \"canvas_object_kind\": \"<string>\",\n \"canvas_object_label\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.gominerva.com/risk-assessments/v2/assessments/{assessmentId}/comments")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"markdown\": \"<string>\",\n \"subject_id\": \"<string>\",\n \"canvas_id\": \"<string>\",\n \"canvas_object_id\": \"<string>\",\n \"canvas_object_kind\": \"<string>\",\n \"canvas_object_label\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gominerva.com/risk-assessments/v2/assessments/{assessmentId}/comments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"markdown\": \"<string>\",\n \"subject_id\": \"<string>\",\n \"canvas_id\": \"<string>\",\n \"canvas_object_id\": \"<string>\",\n \"canvas_object_kind\": \"<string>\",\n \"canvas_object_label\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": 200,
"msg": "OK",
"result": {}
}{
"status": 400,
"msg": "Bad Request",
"error": "<string>"
}{
"status": 400,
"msg": "Bad Request",
"error": "<string>"
}{
"status": 400,
"msg": "Bad Request",
"error": "<string>"
}{
"status": 400,
"msg": "Bad Request",
"error": "<string>"
}Review And Collaboration
Add an assessment comment
Adds a general or object-scoped comment to the assessment audit trail. created_by is derived from the application key.
POST
/
assessments
/
{assessmentId}
/
comments
Add an assessment comment
curl --request POST \
--url https://api.gominerva.com/risk-assessments/v2/assessments/{assessmentId}/comments \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"markdown": "<string>",
"subject_id": "<string>",
"canvas_id": "<string>",
"canvas_object_id": "<string>",
"canvas_object_kind": "<string>",
"canvas_object_label": "<string>"
}
'import requests
url = "https://api.gominerva.com/risk-assessments/v2/assessments/{assessmentId}/comments"
payload = {
"markdown": "<string>",
"subject_id": "<string>",
"canvas_id": "<string>",
"canvas_object_id": "<string>",
"canvas_object_kind": "<string>",
"canvas_object_label": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
markdown: '<string>',
subject_id: '<string>',
canvas_id: '<string>',
canvas_object_id: '<string>',
canvas_object_kind: '<string>',
canvas_object_label: '<string>'
})
};
fetch('https://api.gominerva.com/risk-assessments/v2/assessments/{assessmentId}/comments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gominerva.com/risk-assessments/v2/assessments/{assessmentId}/comments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'markdown' => '<string>',
'subject_id' => '<string>',
'canvas_id' => '<string>',
'canvas_object_id' => '<string>',
'canvas_object_kind' => '<string>',
'canvas_object_label' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gominerva.com/risk-assessments/v2/assessments/{assessmentId}/comments"
payload := strings.NewReader("{\n \"markdown\": \"<string>\",\n \"subject_id\": \"<string>\",\n \"canvas_id\": \"<string>\",\n \"canvas_object_id\": \"<string>\",\n \"canvas_object_kind\": \"<string>\",\n \"canvas_object_label\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.gominerva.com/risk-assessments/v2/assessments/{assessmentId}/comments")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"markdown\": \"<string>\",\n \"subject_id\": \"<string>\",\n \"canvas_id\": \"<string>\",\n \"canvas_object_id\": \"<string>\",\n \"canvas_object_kind\": \"<string>\",\n \"canvas_object_label\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gominerva.com/risk-assessments/v2/assessments/{assessmentId}/comments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"markdown\": \"<string>\",\n \"subject_id\": \"<string>\",\n \"canvas_id\": \"<string>\",\n \"canvas_object_id\": \"<string>\",\n \"canvas_object_kind\": \"<string>\",\n \"canvas_object_label\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": 200,
"msg": "OK",
"result": {}
}{
"status": 400,
"msg": "Bad Request",
"error": "<string>"
}{
"status": 400,
"msg": "Bad Request",
"error": "<string>"
}{
"status": 400,
"msg": "Bad Request",
"error": "<string>"
}{
"status": 400,
"msg": "Bad Request",
"error": "<string>"
}Authorizations
Use the format Api-Key YOUR_API_KEY.
Path Parameters
Risk assessment id.
Body
application/json
⌘I