Member Junction
    Preparing search index...

    Interface GetRecordDependenciesOptions

    Options controlling how Metadata.GetRecordDependencies discovers dependent records.

    interface GetRecordDependenciesOptions {
        EntityNames?: string[];
        IncludeSystemEntities?: boolean;
        LinkType?: "both" | "hard" | "soft";
    }
    Index

    Properties

    EntityNames? IncludeSystemEntities? LinkType?

    Properties

    EntityNames?: string[]

    Optional allow-list of entity names to restrict the dependency scan to.

    IncludeSystemEntities?: boolean

    Whether to include high-volume system audit/telemetry entities (MJ: Record Changes, MJ: Audit Logs, MJ: User Record Logs, MJ: User RecordAccess). Defaults to true for delete/merge safety checks; UI record-link viewers pass false.

    LinkType?: "both" | "hard" | "soft"

    Which category of foreign-key links to inspect:

    • 'both' (default): Both hard database foreign keys (EntityField.RelatedEntityID) and polymorphic / soft foreign keys (EntityField.EntityIDFieldName).
    • 'hard': Only direct foreign-key relationships (RelatedEntityID is set and EntityIDFieldName is empty).
    • 'soft': Only polymorphic foreign-key relationships (EntityIDFieldName is set).

    Settings

    Member Visibility

    On This Page

    Properties