Interface IUpdateRecordSeriesPropertiesRequest

Request body for partial-update of a record series' retention defaults. Every member is optional: null = leave unchanged. Id members accept 0 to clear the assignment.

interface IUpdateRecordSeriesPropertiesRequest {
    cascade?: boolean;
    cutoffCriterionId?: number;
    dispositionAuthority?: string;
    dispositionScheduleId?: number;
    isPermanent?: boolean;
    reviewCycleId?: number;
    reviewInterval?: number;
    reviewIntervalUnit?: LfRepositoryClientV2.ReviewIntervalUnit;
}

Implemented by

Properties

cascade? cutoffCriterionId? dispositionAuthority? dispositionScheduleId? isPermanent? reviewCycleId? reviewInterval? reviewIntervalUnit?

Properties

Optionalcascade

cascade?: boolean

When true, cascade the changed defaults to the record folders and records beneath the series. When false (default), only the series' own defaults change.

OptionalcutoffCriterionId

cutoffCriterionId?: number

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

OptionaldispositionAuthority

dispositionAuthority?: string

The disposition authority name; empty string to clear.

OptionaldispositionScheduleId

dispositionScheduleId?: number

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

OptionalisPermanent

isPermanent?: boolean

Whether records under the series are permanent (never destroyed).

OptionalreviewCycleId

reviewCycleId?: number

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

OptionalreviewInterval

reviewInterval?: number

The default vital-record review interval to set.

OptionalreviewIntervalUnit

reviewIntervalUnit?: LfRepositoryClientV2.ReviewIntervalUnit

The default review interval unit.

Settings

Member Visibility

On This Page

Properties