List archive controls and actual/pending source preservation acknowledgments with an audited purpose

GET/bank-records/controls

Query parameters

afterstringOptional

purposestringOptional

Returns

200 OK

completebooleanRequired

itemsarray of objectsRequired

10 child attributes

actorstringRequired

created_atstring · date-timeRequired

decided_atstring · date-time or nullOptional

decided_bystringOptional

idstringRequired

preservationarray of objectsRequired

6 child attributes

decisionstringRequired

last_attempt_atstring · date-time or nullOptional

receiptobject or nullOptional

5 child attributes

enforcementstringRequired

recorded_atstring · date-timeRequired

requestobjectRequired

request_sha256stringRequired

servicestringRequired

statusstringRequired

targetobjectRequired

2 child attributes

servicestringRequired

sourcestringRequired

versionintegerRequired

requestobjectRequired

13 child attributes

bank_widebooleanRequired

categorystringOptional

event_atstring · date-time or nullOptional

evidence_refstringRequired

evidence_sha256stringRequired

expected_versionintegerOptional

hold_idstringOptional

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

kindstringRequired

matter_refstringRequired

reasonstringRequired

record_idstringOptional

targetobjectRequired

2 child attributes

servicestringRequired

sourcestringRequired

throughstring · date-time or nullOptional

Through bounds a dispose_versions control: the source removes its retained row versions superseded on or before this time, once the control is independently approved and no archive hold covers the source.

statusstringRequired

versionintegerRequired

version_dispositionobject or nullOptional

VersionDisposition is the source's receipt for an approved dispose_versions control; until it is recorded the approved control is still to be propagated.

5 child attributes

deletedintegerRequired

recorded_atstring · date-timeRequired

requestobjectRequired

VersionDispositionRequest is the hub's independently approved instruction to remove an inventory source's retained row versions superseded on or before Through. It applies only to a source under no acknowledged preservation; the archive keeps what it captured.

7 child attributes

command_idstringRequired

evidence_sha256stringRequired

matter_idstringRequired

on_behalf_ofstringRequired

purposestringRequired

sourcestringRequired

throughstring · date-timeRequired

request_sha256stringRequired

servicestringRequired

next_cursorstringRequired

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503