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 schemas

Retained 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.

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_controls.governanceRevisionRequired
    integer

    Minimum: 1.

    applied_controls.organizationApprovalRequired
    object
    applied_controls.organizationApproval fields and rules
    applied_controls.organizationApproval.requireSecondReviewRequired
    boolean

    Default: false.

    applied_controls.organizationApproval.secondReviewForRequired
    string[]

    Maximum items: 4. Default: [].

    applied_controls.organizationApproval.secondReviewFor item fields

    Each array item: string.

    Values: "same_identity", "allow", "restrict", "escalate".

    applied_controls.organizationApproval.approverRolesRequired
    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_controls.restrictedRolesRequired
    object
    applied_controls.restrictedRoles fields and rules
    applied_controls.restrictedRoles.approvalRequired
    string[]
    applied_controls.restrictedRoles.approval item fields

    Each array item: string.

    Values: "analyst", "developer", "viewer".

    applied_controls.restrictedRoles.productionRequired
    string[]
    applied_controls.restrictedRoles.production item fields

    Each array item: string.

    Values: "analyst", "developer", "viewer".

    Additional fields are not accepted.

    applied_controls.screeningPolicyRequired
    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_controls.screeningPolicy.idRequired
      string

      Format: uuid.

      applied_controls.screeningPolicy.versionRequired
      integer

      Minimum: 1.

      applied_controls.screeningPolicy.reviewRequired
      object
      applied_controls.screeningPolicy.review fields and rules
      applied_controls.screeningPolicy.review.requireSecondReviewRequired
      boolean

      Default: false.

      applied_controls.screeningPolicy.review.secondReviewForRequired
      string[]

      Maximum items: 4. Default: [].

      applied_controls.screeningPolicy.review.secondReviewFor item fields

      Each array item: string.

      Values: "same_identity", "allow", "restrict", "escalate".

      applied_controls.screeningPolicy.review.approverRolesRequired
      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.

    Additional fields are not accepted.

  • null

    May be null.

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.