API REFERENCE · SCHEMA
ArchiveDecision schema
Required fields are always present in their containing object. Optional fields may be omitted; null is allowed only where stated. Array item fields apply to every item.
All endpoints and schemasRetained record for archive category decisions. Keys retain their stored snake_case spelling. Nullable columns are included with null values. Expired records use ArchiveExpiredRecord instead; holdings can omit expired reason text.
idRequired- string
Format: uuid.
organization_idRequired- string
case_idRequired- string
Format: uuid.
actor_idRequired- string
decisionRequired- string
business_dispositionRequired- string
review_started_atRequired- string or null
May be null.
review_started_at fields and rules
Allowed alternatives
- string
Format: date-time.
- null
May be null.
- string
applied_controlsRequired- AppliedDecisionControls or null
May be null.
applied_controls fields and rules
Allowed alternatives
- AppliedDecisionControls
Immutable decision-time approval configuration. A null appliedControls value on a decision means no historic snapshot is available; current settings are never substituted. Notification recipients and document hosts are excluded.
applied_controlsRequired.governanceRevision - integer
Minimum: 1.
applied_controlsRequired.organizationApproval - object
applied_controls.organizationApproval fields and rules
applied_controlsRequired.organizationApproval .requireSecondReview - boolean
Default: false.
applied_controlsRequired.organizationApproval .secondReviewFor - string[]
Maximum items: 4. Default: [].
applied_controls.organizationApproval.secondReviewFor item fields
Each array item: string.
Values: "same_identity", "allow", "restrict", "escalate".
applied_controlsRequired.organizationApproval .approverRoles - string[]
Minimum items: 1. Maximum items: 3. Default: ["owner","admin","analyst"].
applied_controls.organizationApproval.approverRoles item fields
Each array item: string.
Values: "owner", "admin", "analyst".
Additional fields are not accepted.
applied_controlsRequired.restrictedRoles - object
applied_controls.restrictedRoles fields and rules
applied_controlsRequired.restrictedRoles .approval - string[]
applied_controls.restrictedRoles.approval item fields
Each array item: string.
Values: "analyst", "developer", "viewer".
applied_controlsRequired.restrictedRoles .production - string[]
applied_controls.restrictedRoles.production item fields
Each array item: string.
Values: "analyst", "developer", "viewer".
Additional fields are not accepted.
applied_controlsRequired.screeningPolicy - object or null
May be null.
applied_controls.screeningPolicy fields and rules
Allowed alternatives
- Provide applied_controls.screeningPolicy.id and applied_controls.screeningPolicy.version and applied_controls.screeningPolicy.review.
applied_controlsRequired.screeningPolicy .id - string
Format: uuid.
applied_controlsRequired.screeningPolicy .version - integer
Minimum: 1.
applied_controlsRequired.screeningPolicy .review - object
applied_controls.screeningPolicy.review fields and rules
applied_controlsRequired.screeningPolicy .review .requireSecondReview - boolean
Default: false.
applied_controlsRequired.screeningPolicy .review .secondReviewFor - string[]
Maximum items: 4. Default: [].
applied_controls.screeningPolicy.review.secondReviewFor item fields
Each array item: string.
Values: "same_identity", "allow", "restrict", "escalate".
applied_controlsRequired.screeningPolicy .review .approverRoles - string[]
Minimum items: 1. Maximum items: 3. Default: ["owner","admin","analyst"].
applied_controls.screeningPolicy.review.approverRoles item fields
Each array item: string.
Values: "owner", "admin", "analyst".
Additional fields are not accepted.
Additional fields are not accepted.
- null
May be null.
- Provide applied_controls.screeningPolicy.id and applied_controls.screeningPolicy.version and applied_controls.screeningPolicy.review.
Additional fields are not accepted.
- null
May be null.
- AppliedDecisionControls
notesRequired- string
created_atRequired- string
Format: date-time.
expires_atRequired- string or null
May be null.
expires_at fields and rules
Allowed alternatives
- string
Format: date-time.
- null
May be null.
- string