@labkey/api
    Preparing search index...

    Interface LoadRunsOptions

    Several Experiment API endpoints expose optional settings for the ExperimentJSONConverter.

    interface LoadRunsOptions {
        containerPath?: string;
        failure?: RequestFailure<any>;
        includeInputsAndOutputs?: boolean;
        includeProperties?: boolean;
        includeRunSteps?: boolean;
        lsids?: string[];
        runIds?: number[];
        scope?: any;
        success?: RequestSuccess<Run[]>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    containerPath? failure? includeInputsAndOutputs? includeProperties? includeRunSteps? lsids? runIds? scope? success?

    Properties

    containerPath?: string

    Load runs from a specific container. If not specified, the runs will be loaded from the current container.

    failure?: RequestFailure<any>

    This will be called upon failure to complete a request.

    includeInputsAndOutputs?: boolean

    Include run and step inputs and outputs.

    includeProperties?: boolean

    Include properties set on the experiment objects.

    includeRunSteps?: boolean

    Include run steps.

    lsids?: string[]

    An Array of run LSIDs to fetch.

    runIds?: number[]

    An Array of run ids to fetch.

    scope?: any

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

    success?: RequestSuccess<Run[]>

    This will be called upon successfully completing a request.

    Settings

    Member Visibility

    On This Page

    Properties