@labkey/api
    Preparing search index...

    Interface CreateDomainOptions

    interface CreateDomainOptions {
        containerPath?: string;
        createDomain?: boolean;
        domainDesign?: DomainDesign;
        domainGroup?: string;
        domainKind?: string;
        domainTemplate?: string;
        failure?: RequestFailure<any>;
        importData?: boolean;
        kind?: string;
        module?: string;
        options?: any;
        scope?: any;
        success?: RequestSuccess<any>;
        timeout?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    containerPath? createDomain? domainDesign? domainGroup? domainKind? domainTemplate? failure? importData? kind? module? options? scope? success? timeout?

    Properties

    containerPath?: string

    The container path in which to create the domain.

    createDomain?: boolean

    When using a domain template, create the domain. Defaults to true.

    domainDesign?: DomainDesign

    The domain design to save.

    domainGroup?: string

    The name of a domain template group.

    domainKind?: string

    The domain kind to create. One of "IntList", "VarList", "SampleSet", or "DataClass".

    domainTemplate?: string

    The name of a domain template within the domain group.

    failure?: RequestFailure<any>

    This will be called upon failure to complete a request.

    importData?: boolean

    When using a domain template, import initial data associated in the template. Defaults to true.

    kind?: string

    The domain kind to create. Currently supported:

    • DataClass
    • IntList
    • SampleSet
    • StudyDatasetDate
    • StudyDatasetVisit
    • VarList
    module?: string

    The name of a module that contains the domain template group.

    options?: any

    Arguments used to create the specific domain type.

    scope?: any

    A scoping object for the success and failure callback functions (default to this).

    success?: RequestSuccess<any>

    This will be called upon successfully completing a request.

    timeout?: number

    Settings

    Member Visibility

    On This Page

    Properties