@labkey/api
    Preparing search index...

    Interface ResolveOptions

    Several Experiment API endpoints expose optional settings for the ExperimentJSONConverter.

    interface ResolveOptions {
        containerPath?: string;
        failure?: RequestFailure<any>;
        includeInputsAndOutputs?: boolean;
        includeProperties?: boolean;
        includeRunSteps?: boolean;
        lsids?: string[];
        scope?: any;
        success?: RequestSuccess<ResolveResponse>;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    containerPath?: string

    The path to the container in which the LSIDs are defined. If not supplied, the current container's path will be used. All requested LSID's must be defined in the same container. If they are not, then you should consider making separate requests per 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[]

    The list of run lsids.

    scope?: any

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

    success?: RequestSuccess<ResolveResponse>

    This will be called upon successfully completing a request.

    Settings

    Member Visibility

    On This Page

    Properties