@labkey/api
    Preparing search index...

    Interface GetByIdOptions

    interface GetByIdOptions {
        containerPath?: string;
        failure?: RequestFailure<any>;
        id: number;
        name?: string;
        parameters?: GetAssaysParameters;
        plateEnabled?: boolean;
        scope?: any;
        status?: string;
        success?: RequestSuccess<AssayDesign[]>;
        type?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    containerPath? failure? id name? parameters? plateEnabled? scope? status? success? type?

    Properties

    containerPath?: string

    The container path in which the requested Assays are defined. If not supplied, the current container path will be used.

    failure?: RequestFailure<any>

    This will be called upon failure to complete a request.

    id: number

    Unique integer ID for the assay.

    name?: string

    Applies a filter to match against only assay designs with the provided "name".

    parameters?: GetAssaysParameters

    Specify any/all parameters directly on GetAssaysOptions instead.

    plateEnabled?: boolean

    Applies a filter to match against only assay designs with the provided "plateEnabled" value.

    scope?: any

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

    status?: string

    Applies a filter to match against only assay designs with the provided "status". Supported statuses are "Active" and "Archived".

    success?: RequestSuccess<AssayDesign[]>

    This will be called upon successfully completing a request.

    type?: string

    Applies a filter to match against only assay designs with the provided "type".

    Settings

    Member Visibility

    On This Page

    Properties