Download an assessment declaration's file
Redirect to a freshly signed, five-minute URL for one file of one of an assessment's declarations. Readable by whoever may read the assessment; anyone else gets 404
get
https://localhost:10001/api/v1/organizations/{orgId}/assessments/{assessmentId}/declarations/{declarationId}/files/{attachmentId}/downloadbash
curl --request GET \
--url 'https://localhost:10001/api/v1/organizations/{orgId}/assessments/{assessmentId}/declarations/{declarationId}/files/{attachmentId}/download' \
--header 'Authorization: Bearer <token>'javascript
const response = await fetch("https://localhost:10001/api/v1/organizations/{orgId}/assessments/{assessmentId}/declarations/{declarationId}/files/{attachmentId}/download", {
method: "GET",
headers: {
"Authorization": "Bearer <token>"
}
});
console.log(response.status);typescript
const response = await fetch("https://localhost:10001/api/v1/organizations/{orgId}/assessments/{assessmentId}/declarations/{declarationId}/files/{attachmentId}/download", {
method: "GET",
headers: {
"Authorization": "Bearer <token>"
}
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);
console.log(response.status);python
import requests
response = requests.get(
"https://localhost:10001/api/v1/organizations/{orgId}/assessments/{assessmentId}/declarations/{declarationId}/files/{attachmentId}/download",
headers={
"Authorization": "Bearer <token>",
},
)
response.raise_for_status()
print(response.status_code)go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, err := http.NewRequest(http.MethodGet, "https://localhost:10001/api/v1/organizations/{orgId}/assessments/{assessmentId}/declarations/{declarationId}/files/{attachmentId}/download", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer <token>")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
data, err := io.ReadAll(res.Body)
if err != nil {
panic(err)
}
fmt.Println(res.Status, string(data))
}java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://localhost:10001/api/v1/organizations/{orgId}/assessments/{assessmentId}/declarations/{declarationId}/files/{attachmentId}/download"))
.header("Authorization", "Bearer <token>")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}csharp
using System.Net.Http.Headers;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:10001/api/v1/organizations/{orgId}/assessments/{assessmentId}/declarations/{declarationId}/files/{attachmentId}/download");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");php
<?php
$ch = curl_init('https://localhost:10001/api/v1/organizations/{orgId}/assessments/{assessmentId}/declarations/{declarationId}/files/{attachmentId}/download');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer <token>',
],
CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;ruby
require "net/http"
uri = URI("https://localhost:10001/api/v1/organizations/{orgId}/assessments/{assessmentId}/declarations/{declarationId}/files/{attachmentId}/download")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"rust
// Cargo.toml dependencies: reqwest, tokio (features "full")
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let response = reqwest::Client::new()
.get("https://localhost:10001/api/v1/organizations/{orgId}/assessments/{assessmentId}/declarations/{declarationId}/files/{attachmentId}/download")
.header("Authorization", "Bearer <token>")
.send()
.await?;
println!("{} {}", response.status(), response.text().await?);
Ok(())
}Authorizations
BearerAuth· API key in header "Authorization" — Type "Bearer" followed by a space and JWT token.
Parameters
Path parameters
| Name | Type | Description |
|---|---|---|
orgIdrequired | string | Organization ID or UUID (urn:uuid optional) |
assessmentIdrequired | string | Assessment UUID (urn:uuid optional) |
declarationIdrequired | string | Declaration UUID (urn:uuid optional) |
attachmentIdrequired | integer | The file's attachment ID, from the declaration's attachments |
Responses
307Redirect to the signed URL
400Bad request - Invalid declaration ID or attachment ID
application/json
errorstring
Examplejson
{
"error": "Invalid request body"
}401Unauthorized - Authentication required
application/json
errorstring
Examplejson
{
"error": "Invalid request body"
}403Forbidden - No organization access
application/json
errorstring
Examplejson
{
"error": "Invalid request body"
}404Assessment, declaration or file not found, or not readable by the caller
application/json
errorstring
Examplejson
{
"error": "Invalid request body"
}500Internal server error
application/json
errorstring
Examplejson
{
"error": "Invalid request body"
}