Interface GetByNameOptions

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

Hierarchy (view full)

Properties

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

Properties

OptionalcontainerPath

containerPath?: string

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

Optionalfailure

failure?: RequestFailure<any>

This will be called upon failure to complete a request.

Optionalid

id?: number

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

name

name: string

String name of the assay.

Optionalparameters

parameters?: GetAssaysParameters

Deprecated

Specify any/all parameters directly on GetAssaysOptions instead.

OptionalplateEnabled

plateEnabled?: boolean

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

Optionalscope

scope?: any

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

Optionalstatus

status?: string

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

Optionalsuccess

success?: RequestSuccess<AssayDesign[]>

This will be called upon successfully completing a request.

Optionaltype

type?: string

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

Settings

Member Visibility

On This Page

Properties