One immutable report snapshot: its state hash, manifest, report and checks
GET
/v1/entities/{entity_id}/snapshots/{snapshot_id}
const url = 'https://example.com/v1/entities/example/snapshots/example';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/v1/entities/example/snapshots/exampleParameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”snapshot_id
required
Snapshot Id
string
entity_id
required
Entity Id
The entity this path is relative to
string
The entity this path is relative to
Responses
Section titled “Responses”Successful Response
Media typeapplication/json
Snapshot
object
entity_id
required
Entity Id
string
legal_name
required
Legal Name
string
base_currency
required
Base Currency
string
snapshot_seq
required
Snapshot Seq
integer
id
required
Id
string
snapshot_seq_of_snapshot
required
Snapshot Seq Of Snapshot
integer
state_hash
required
State Hash
string
through
required
Through
string
manifest
required
Manifest
report
required
Report
checks
required
Checks
created_at
required
Created At
string
created_by
required
Created By
string
links
required
Links
object
key
additional properties
string
Example generated
{ "entity_id": "example", "legal_name": "example", "base_currency": "example", "snapshot_seq": 1, "id": "example", "snapshot_seq_of_snapshot": 1, "state_hash": "example", "through": "example", "manifest": "example", "report": "example", "checks": "example", "created_at": "example", "created_by": "example", "links": { "additionalProperty": "example" }}Bad Request
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Unauthorized
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Forbidden
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Not Found
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Conflict
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Precondition Failed
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Unprocessable Content
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Internal Server Error
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}Service Unavailable
Media typeapplication/json
ErrorEnvelope
object
Example generated
{ "error": { "code": "example", "message": "example", "retryable": true, "details": [ {} ], "request_id": "example", "next_action": {} }}