Interface IRecordsManagementClient

interface IRecordsManagementClient {
    createRecordSeries(
        args: {
            parentEntryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.CreateRecordSeriesRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>;
    getAltRetentionEvents(
        args: { entryId: number; repositoryId: string; select?: null | string },
    ): Promise<LfRepositoryClientV2.AltRetentionEventCollection>;
    getEligibleRecords(
        args: {
            eligibleFor?: null | LfRepositoryClientV2.EligibleRecordsAction;
            entryId: number;
            repositoryId: string;
            select?: null | string;
        },
    ): Promise<LfRepositoryClientV2.RecordEntryIdCollection>;
    getEntryRecordsManagementProperties(
        args: { entryId: number; repositoryId: string; select?: null | string },
    ): Promise<LfRepositoryClientV2.RecordsManagementProperties>;
    getIndependentRecords(
        args: { entryId: number; repositoryId: string; select?: null | string },
    ): Promise<LfRepositoryClientV2.RecordEntryIdCollection>;
    getRecordSeriesProperties(
        args: { entryId: number; repositoryId: string; select?: null | string },
    ): Promise<LfRepositoryClientV2.RecordSeriesProperties>;
    removeRecordEvent(
        args: {
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.RemoveRecordEventRequest;
        },
    ): Promise<LfRepositoryClientV2.RecordsManagementProperties>;
    setRecordEvent(
        args: {
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.SetRecordEventRequest;
        },
    ): Promise<LfRepositoryClientV2.RecordsManagementProperties>;
    updateEntryRecordsManagementProperties(
        args: {
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.UpdateRecordsManagementPropertiesRequest;
        },
    ): Promise<LfRepositoryClientV2.RecordsManagementProperties>;
    updateRecordSeriesProperties(
        args: {
            entryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.UpdateRecordSeriesPropertiesRequest;
        },
    ): Promise<LfRepositoryClientV2.RecordSeriesProperties>;
}

Implemented by

Methods

createRecordSeries getAltRetentionEvents getEligibleRecords getEntryRecordsManagementProperties getIndependentRecords getRecordSeriesProperties removeRecordEvent setRecordEvent updateEntryRecordsManagementProperties updateRecordSeriesProperties

Methods

createRecordSeries

  • createRecordSeries(
        args: {
            parentEntryId: number;
            repositoryId: string;
            request: LfRepositoryClientV2.CreateRecordSeriesRequest;
        },
    ): Promise<LfRepositoryClientV2.Entry>
    • A record series provides cascading retention defaults for the file plan beneath it.
    • The parent must be the file-plan root or another record series; creating one under a normal folder is rejected.
    • Deleting a record series uses the existing Delete Entry endpoint (a record series is an entry).
    • Required OAuth scope: repository.Write

    Parameters

    • args: {
          parentEntryId: number;
          repositoryId: string;
          request: LfRepositoryClientV2.CreateRecordSeriesRequest;
      }
      • parentEntryId: number

        The parent the record series is created under. A record series belongs to the record file plan, so the parent must be the repository's file-plan root or an existing record series — it cannot be a normal folder (the server returns an error if it is).

      • repositoryId: string

        The requested repository ID.

      • request: LfRepositoryClientV2.CreateRecordSeriesRequest

        The new record series' name and code.

    Returns Promise<LfRepositoryClientV2.Entry>

    Successfully created the record series. Returned the created entry.

getAltRetentionEvents

  • getAltRetentionEvents(
        args: { entryId: number; repositoryId: string; select?: null | string },
    ): Promise<LfRepositoryClientV2.AltRetentionEventCollection>

    Parameters

    • args: { entryId: number; repositoryId: string; select?: null | string }
      • entryId: number
      • repositoryId: string
      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

    Returns Promise<LfRepositoryClientV2.AltRetentionEventCollection>

    Successfully returned the record folder's alternate-retention trigger events.

getEligibleRecords

getEntryRecordsManagementProperties

  • getEntryRecordsManagementProperties(
        args: { entryId: number; repositoryId: string; select?: null | string },
    ): Promise<LfRepositoryClientV2.RecordsManagementProperties>

    Parameters

    • args: { entryId: number; repositoryId: string; select?: null | string }
      • entryId: number
      • repositoryId: string
      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

    Returns Promise<LfRepositoryClientV2.RecordsManagementProperties>

    Successfully returned the entry's records management properties.

getIndependentRecords

  • getIndependentRecords(
        args: { entryId: number; repositoryId: string; select?: null | string },
    ): Promise<LfRepositoryClientV2.RecordEntryIdCollection>

    Parameters

    • args: { entryId: number; repositoryId: string; select?: null | string }
      • entryId: number
      • repositoryId: string
      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

    Returns Promise<LfRepositoryClientV2.RecordEntryIdCollection>

    Successfully returned the ids of the independent records under the record folder.

getRecordSeriesProperties

  • getRecordSeriesProperties(
        args: { entryId: number; repositoryId: string; select?: null | string },
    ): Promise<LfRepositoryClientV2.RecordSeriesProperties>

    Parameters

    • args: { entryId: number; repositoryId: string; select?: null | string }
      • entryId: number
      • repositoryId: string
      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

    Returns Promise<LfRepositoryClientV2.RecordSeriesProperties>

    Successfully returned the record series properties.

removeRecordEvent

setRecordEvent

updateEntryRecordsManagementProperties

updateRecordSeriesProperties

Settings

Member Visibility

On This Page

Methods