Get the summary for an assessment
curl --request GET \
--url https://app.visotrust.com/api/v1/assessments/{id}/summaryimport requests
url = "https://app.visotrust.com/api/v1/assessments/{id}/summary"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://app.visotrust.com/api/v1/assessments/{id}/summary', 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://app.visotrust.com/api/v1/assessments/{id}/summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.visotrust.com/api/v1/assessments/{id}/summary"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.visotrust.com/api/v1/assessments/{id}/summary")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.visotrust.com/api/v1/assessments/{id}/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": 123,
"summary": "<string>",
"version": "<string>",
"edited": true
}Assessments
Get the summary for an assessment
Returns the assessment summary as the stored HTML report by default. If the summary has been edited, the edit is returned.
Pass format=markdown to get the same content as Markdown instead — headings, lists and tables are
preserved, but the markup and styling are not, so the summary can be read as text or fed to another
system without stripping HTML first.
GET
/
api
/
v1
/
assessments
/
{id}
/
summary
Get the summary for an assessment
curl --request GET \
--url https://app.visotrust.com/api/v1/assessments/{id}/summaryimport requests
url = "https://app.visotrust.com/api/v1/assessments/{id}/summary"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://app.visotrust.com/api/v1/assessments/{id}/summary', 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://app.visotrust.com/api/v1/assessments/{id}/summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.visotrust.com/api/v1/assessments/{id}/summary"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.visotrust.com/api/v1/assessments/{id}/summary")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.visotrust.com/api/v1/assessments/{id}/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"id": 123,
"summary": "<string>",
"version": "<string>",
"edited": true
}Path Parameters
Query Parameters
The format to render the summary in
Available options:
html, markdown Response
200 - application/json
OK
The assessment's identifier
The assessment summary, as HTML by default or as Markdown when 'format=markdown' is requested
Identifies this revision of the summary. Pass it back when updating the summary to have the update rejected if the summary has changed in the meantime.
Whether the summary has been edited since it was generated