Overview

You can use BioSamples filters are to filter resources based on their characteristics. BioSamples filters are generally composed by a type, a field and a value combined as <type>:<field>:<value> Note that if a value is not provided, the filter will check for existence of the provided field. You can use search filters in both sample and accession search endpoints.

Type of filter

Attribute

Filter based on samples' attributes and attribute’s value

Field Value Notes

type

attr

field

Attribute name

Case sensitive, encoded

value

Attribute value

Case sensitive, encoded

Example

Date range

Range filter based on samples' update date or release date

Field Value Notes

type

dt

field

release | update

Case sensitive

value

Date range in the format of from=<date>until=<date>

Dates should be formatted using ISO8601; timezone is UTC by default; from= and until= are optional

Examples

Accession

Filter based on samples' accession

Field Value Notes

type

acc

field

NA

The field is predefined

value

Sample accession

Examples

Relationship

Filter based on samples relationship source

Field Value Notes

type

rel

field

relation type

Case sensitive, encoded

value

relation target

An accession

Examples

Reverse Relationship

Filter based on samples' relationship target

Field Value Notes

type

rrel

field

relation type

Case sensitive, encoded

value

relation target

Usually an accession

Examples

Domain

Filter based on samples' submission domain

Field Value Notes

type

dom

field

NA

The field is predefined

value

domain

The domain need to include the self. prefix

Examples

Name

Filter based on samples' name

Field Value Notes

type

name

field

NA

The field is predefined

value

A sample name

Case sensitive, encoded

Examples

External Reference Data

Filter based on sample’s link with external data

Field Value Notes

type

extd

field

External reference name

e.g. ENA, ArrayExpress, etc.

value

Externnal data id

Examples