Member Junction
    Preparing search index...

    Interface CreateVersionLabelParams

    Parameters for creating a version label via the server-side VersionHistoryEngine.

    interface CreateVersionLabelParams {
        Description?: string;
        EntityName?: string;
        ExcludeEntities?: string[];
        ExternalSystemID?: string;
        IncludeDependencies?: boolean;
        MaxDepth?: number;
        Name: string;
        OnProgress?: (progress: CreateVersionLabelProgress) => void;
        ParentID?: string;
        RecordKeys?: { Key: string; Value: string }[];
        Scope?: "Entity" | "System" | "Record";
    }
    Index

    Properties

    Description? EntityName? ExcludeEntities? ExternalSystemID? IncludeDependencies? MaxDepth? Name OnProgress? ParentID? RecordKeys? Scope?

    Properties

    Description?: string

    Optional longer description

    EntityName?: string

    The target entity name (required for Entity/Record scope)

    ExcludeEntities?: string[]

    Entity names to exclude from dependency traversal

    ExternalSystemID?: string

    Optional external system reference

    IncludeDependencies?: boolean

    Whether to include dependent records when scope is Record (default: true)

    MaxDepth?: number

    Maximum depth of dependency graph traversal

    Name: string

    Human-readable name

    OnProgress?: (progress: CreateVersionLabelProgress) => void

    Optional callback invoked with progress updates during label creation. Requires an active PushStatusUpdates subscription (handled automatically).

    ParentID?: string

    Optional parent label ID for grouping

    RecordKeys?: { Key: string; Value: string }[]

    The record's primary key pairs (required for Record scope). Key = field name, Value = field value.

    Scope?: "Entity" | "System" | "Record"

    Scope of the label: System, Entity, or Record (default: Record)

    Settings

    Member Visibility

    On This Page

    Properties