API REFERENCE · SCHEMA

CaseArchiveSegment 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
formatRequired
"sanctionskit-case-archive@1"

Must equal "sanctionskit-case-archive@1".

caseIdRequired
string

Format: uuid.

revisionRequired
integer

Minimum: 0.

asOfRequired
string

Format: date-time.

segmentRequired
integer

Minimum: 0.

categoryRequired
string

Values: "case", "screenings", "decisions", "reviews", "reviewHistory", "comments", "attachments", "findings", "corrections", "checks", "documents", "holds", "reuseRules", "audit".

recordsRequired
ArchiveCase or ArchiveScreening or ArchiveDecision or ArchiveReview or ArchiveReviewHistory or ArchiveComment or ArchiveAttachment or ArchiveFinding or ArchiveCorrection or ArchiveCheck or ArchiveDocument or ArchiveHold or ArchiveReuseRule or ArchiveAuditEvent or ArchiveExpiredRecord[]

Record shape follows category: case → ArchiveCase, screenings → ArchiveScreening, decisions → ArchiveDecision, reviews → ArchiveReview, reviewHistory → ArchiveReviewHistory, comments → ArchiveComment, attachments → ArchiveAttachment, findings → ArchiveFinding, corrections → ArchiveCorrection, checks → ArchiveCheck, documents → ArchiveDocument, holds → ArchiveHold, reuseRules → ArchiveReuseRule, audit → ArchiveAuditEvent. Expired content is replaced by ArchiveExpiredRecord. Non-case segments contain at most 25 records and may be empty while advancing to the next category.

records item fields

Each array item: ArchiveCase or ArchiveScreening or ArchiveDecision or ArchiveReview or ArchiveReviewHistory or ArchiveComment or ArchiveAttachment or ArchiveFinding or ArchiveCorrection or ArchiveCheck or ArchiveDocument or ArchiveHold or ArchiveReuseRule or ArchiveAuditEvent or ArchiveExpiredRecord.

Allowed alternatives

nextCursorRequired
string or null

May be null.

nextCursor fields and rules

Allowed alternatives

  • string
  • null

    May be null.

completeRequired
boolean
limitationsRequired
string[]
limitations item fields

Each array item: string.