Scale Intelligence■ Docs
Docs / The model / LegalHold

LegalHold.

A hold that stops an erasure of a subject, with its reason, who set it and until when

Figure 1LegalHoldspecified
LEGALHOLDdefinition at tenant scopesubjectidreasontextset_byiduntildateoptionalpoints at no other object
LegalHold is a definition at tenant scope. The drawing shows its fields and the objects that they point at.
kind
definition
scope
tenant
key
the subject
store
postgres
family
people

Fields#

fieldtyperequirednote
subjectidyes
reasontextyes
set_byidyes
untildateno

Routes that use it#

No route takes or returns LegalHold directly. The record holds it, and the objects that point at it reach it.