@labkey/api
    Preparing search index...

    Interface IExecuteFunctionOptions

    interface IExecuteFunctionOptions {
        containerPath?: string;
        failure?: RequestFailure<any>;
        functionName: string;
        inputParams?: any;
        queryName?: string;
        reportId?: string;
        reportName?: string;
        reportSessionId?: string;
        schemaName?: string;
        scope?: any;
        success?: RequestSuccess<RequestExecuteResponse>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    containerPath? failure? functionName inputParams? queryName? reportId? reportName? reportSessionId? schemaName? scope? success?

    Properties

    containerPath?: string

    The container in which to make the request (defaults to current container)

    failure?: RequestFailure<any>

    This will be called upon failure to complete a request.

    functionName: string

    The name of the function to execute

    inputParams?: any

    An object with properties for input parameters.

    queryName?: string
    reportId?: string

    Identifier for the report to execute

    reportName?: string

    name of the report to execute if the id is unknown

    reportSessionId?: string

    Execute within the existing report session.

    schemaName?: string

    schema to which this report belongs (only used if reportName is used)

    scope?: any

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

    success?: RequestSuccess<RequestExecuteResponse>

    This will be called upon successfully completing a request.

    Settings

    Member Visibility

    On This Page

    Properties