@labkey/api
    Preparing search index...

    Interface LoadBatchOptions

    interface LoadBatchOptions {
        assayId: number;
        assayName: string;
        batchId: number;
        containerPath?: string;
        failure?: RequestFailure<any>;
        protocolName?: string;
        providerName: string;
        scope?: any;
        success?: RequestSuccess<RunGroup>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    assayId assayName batchId containerPath? failure? protocolName? providerName scope? success?

    Properties

    assayId: number

    The assay protocol id.

    assayName: string

    The name of the assay.

    batchId: number

    The batch id.

    containerPath?: string

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

    failure?: RequestFailure<any>

    This will be called upon failure to complete a request.

    protocolName?: string

    Optional protocol name to be used for non-assay backed runs. Currently only SAMPLE_DERIVATION_PROTOCOL is supported.

    providerName: string

    The assay provider name.

    scope?: any

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

    success?: RequestSuccess<RunGroup>

    This will be called upon successfully completing a request.

    Settings

    Member Visibility

    On This Page

    Properties