@labkey/api
    Preparing search index...

    Interface GetQueryDetailsOptions

    interface GetQueryDetailsOptions {
        containerPath?: string;
        failure?: RequestFailure<any>;
        fields?: string | string[];
        fk?: string;
        includeTriggers?: boolean;
        initializeMissingView?: boolean;
        method?: "GET" | "POST";
        queryName: string;
        schemaName: string;
        scope?: any;
        success?: RequestSuccess<QueryDetailsResponse>;
        viewName?: string | string[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    containerPath? failure? fields? fk? includeTriggers? initializeMissingView? method? queryName schemaName scope? success? viewName?

    Properties

    containerPath?: string

    A container path in which to execute this command. If not supplied, the current container will be used.

    failure?: RequestFailure<any>

    This will be called upon failure to complete a request.

    fields?: string | string[]

    A field key or Array of field keys to include in the metadata.

    fk?: string

    When specified the response will only include columns from the specified foreign key query.

    includeTriggers?: boolean

    Include trigger metadata in the response.

    initializeMissingView?: boolean

    Initialize the view based on the default view iff the view doesn't yet exist.

    method?: "GET" | "POST"

    Specify the HTTP method to use when making the request. Defaults to GET.

    queryName: string

    The name of the query.

    schemaName: string

    The name of the schema.

    scope?: any

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

    success?: RequestSuccess<QueryDetailsResponse>

    This will be called upon successfully completing a request.

    viewName?: string | string[]

    A view name or Array of view names to include custom view details. Use '*' to include all views for the query.

    Settings

    Member Visibility

    On This Page

    Properties