Member Junction
    Preparing search index...

    Interface CreateLabelParams

    Parameters for creating a new version label.

    interface CreateLabelParams {
        Description?: string;
        EntityName?: string;
        ExcludeEntities?: string[];
        ExternalSystemID?: string;
        IncludeDependencies?: boolean;
        MaxDepth?: number;
        Name: string;
        OnProgress?: CreateLabelProgressCallback;
        ParentID?: string;
        RecordKey?: CompositeKey;
        Scope?: VersionLabelScope;
    }
    Index

    Properties

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

    Properties

    Description?: string

    Optional longer description

    EntityName?: string

    When scope is Entity or Record, the target entity name

    ExcludeEntities?: string[]

    Entity names to exclude from dependency graph traversal. Only relevant when IncludeDependencies is true.

    ExternalSystemID?: string

    Optional external system reference (git SHA, release tag, etc.)

    IncludeDependencies?: boolean

    Whether to include dependent records when scope is Record. If true, walks the dependency graph and captures child/grandchild records. Default: true

    MaxDepth?: number

    Maximum depth of dependency graph traversal. Only relevant when IncludeDependencies is true. Default: 10

    Name: string

    Human-readable name

    OnProgress?: CreateLabelProgressCallback

    Optional callback invoked during label creation to report progress. Useful for long-running operations to display status in the UI.

    ParentID?: string

    Optional parent label ID for grouping related labels

    RecordKey?: CompositeKey

    When scope is Record, the target record key

    Scope?: VersionLabelScope

    Scope of the label (default: Record)

    Settings

    Member Visibility

    On This Page

    Properties