@labkey/api
    Preparing search index...

    Interface IGetDataSource

    interface IGetDataSource {
        containerPath?: string;
        queryName?: string;
        schemaName?: string | string[] | SchemaKey;
        sql?: string;
        type?: "sql" | "query";
    }
    Index

    Properties

    containerPath? queryName? schemaName? sql? type?

    Properties

    containerPath?: string

    The path to the target container to execute the GetData call in.

    queryName?: string

    The queryName to use in the request. Required if source.type = "query".

    schemaName?: string | string[] | SchemaKey

    The schemaName to use in the request. Can be a string, array of strings, or SchemaKey.

    sql?: string

    The LabKey SQL to use in the request. Required if source.type = "sql".

    type?: "sql" | "query"

    A string with value set to either "query" or "sql". Indicates if the value is "sql" then source.sql is required. If the value is "query" then source.queryName is required.

    Settings

    Member Visibility

    On This Page

    Properties