Interface SequenceSearchFilter

interface SequenceSearchFilter {
    filter?: {
        assetIds?: number[];
        assetSubtreeIds?: IdEither[];
        createdTime?: DateRange;
        dataSetIds?: IdEither[];
        externalIdPrefix?: string;
        lastUpdatedTime?: DateRange;
        metadata?: Metadata;
        name?: string;
        rootAssetIds?: number[];
    };
    search?: {
        description?: string;
        name?: string;
        query?: string;
    };
}

Hierarchy (view full)

Properties

filter? search?

Properties

Optionalfilter

filter?: {
    assetIds?: number[];
    assetSubtreeIds?: IdEither[];
    createdTime?: DateRange;
    dataSetIds?: IdEither[];
    externalIdPrefix?: string;
    lastUpdatedTime?: DateRange;
    metadata?: Metadata;
    name?: string;
    rootAssetIds?: number[];
}

Type declaration

  • OptionalassetIds?: number[]
  • OptionalassetSubtreeIds?: IdEither[]

    Only include sequences that have a related asset in a subtree rooted at any of these assetIds. If the total size of the given subtrees exceeds 100,000 assets, an error will be returned.

  • OptionalcreatedTime?: DateRange
  • OptionaldataSetIds?: IdEither[]
  • OptionalexternalIdPrefix?: string
  • OptionallastUpdatedTime?: DateRange
  • Optionalmetadata?: Metadata
  • Optionalname?: string
  • OptionalrootAssetIds?: number[]

    Only include sequences that have a related asset in a tree rooted at any of these root assetIds.

Optionalsearch

search?: {
    description?: string;
    name?: string;
    query?: string;
}

Type declaration

  • Optionaldescription?: string
  • Optionalname?: string
  • Optionalquery?: string

    Search on name and description using wildcard search on each of the words (separated by spaces). Retrieves results where at least one word must match. Example: 'some other'

Settings

Member Visibility

On This Page

Properties