Request body for partial-update of an entry's records management properties. Every member is optional: null = leave unchanged. Id members accept 0 to clear the assignment. Dates are set by supplying a value; the two clearable dates (record folder triggerDate and record lastReviewDate) are cleared via their explicit clear* flags. Applying this update to a plain document promotes it to a record, and to a plain folder promotes it to a record folder, before the properties are applied. Members that do not apply to the entry's resulting type (for example record-folder members on a document record) are rejected with 400.

Implements

Constructors

Properties

clearLastReviewDate?: boolean

When true, clear the last vital-record review date. (record)

clearTriggerDate?: boolean

When true, clear the alternate-retention trigger date. (recordFolder)

cutoffCriterionId?: number

The cutoff criterion id to assign, or 0 to clear.

dispositionAuthority?: string

The disposition authority name; empty string to clear. (recordFolder)

dispositionScheduleId?: number

The disposition schedule id to assign, or 0 to clear.

filingDate?: Date

The filing date to set.

isClosed?: boolean

Whether the record folder is closed to new filings. (recordFolder)

isCutoffCriterionInherited?: boolean

Whether the cutoff criterion is inherited from the record folder. (record)

isDispositionScheduleInherited?: boolean

Whether the disposition schedule is inherited from the record folder. (record)

isPermanent?: boolean

Whether the record folder is permanent (never destroyed). (recordFolder)

lastReviewDate?: Date

The last vital-record review date to set. (record)

reviewCycleId?: number

The vital-record review cycle (calendar cycle) id to assign, or 0 to clear. (recordFolder)

reviewInterval?: number

The vital-record review interval to set. (recordFolder)

The review interval unit. (recordFolder)

triggerDate?: Date

The alternate-retention trigger date to set.

Methods

  • Parameters

    • Optional_data: any

    Returns void

  • Parameters

    • Optionaldata: any

    Returns any