@labkey/api
    Preparing search index...

    Interface GetPropertiesOptions

    interface GetPropertiesOptions {
        containerPath?: string;
        domainIds?: number[];
        domainKinds?: string[];
        failure?: RequestFailure<any>;
        filters?: IFilter[];
        maxRows?: number;
        offset?: number;
        propertyIds?: number[];
        propertyURIs?: string[];
        scope?: any;
        search?: string;
        sort?: string;
        success?: RequestSuccess<any>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    containerPath? domainIds? domainKinds? failure? filters? maxRows? offset? propertyIds? propertyURIs? scope? search? sort? success?

    Properties

    containerPath?: string
    domainIds?: number[]

    Get properties from the given set of domains.

    domainKinds?: string[]

    Get properties from the given set of domain kinds. For example, "Vocabulary" or "SampleSet"

    failure?: RequestFailure<any>

    This will be called upon failure to complete a request.

    filters?: IFilter[]

    Get properties matching the query filters. For example, Filter.create('measure', true) will find all measure properties.

    maxRows?: number
    offset?: number
    propertyIds?: number[]

    Get the properties for the property IDs.

    propertyURIs?: string[]

    Get the properties for the property URIs.

    scope?: any

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

    search?: string

    Get properties that match the search term. The property name, label, description, and importAliases will be considered when searching.

    sort?: string

    Property descriptor field to sort the results by. By default, the results will be returned in propertyId order.

    success?: RequestSuccess<any>

    This will be called upon successfully completing a request.

    Settings

    Member Visibility

    On This Page

    Properties