Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

RMA Path Syntax

Use the RMA path syntax to describe a path connecting associated models in the schema. It is used in the include= and criteria= URL parameters. Please note that the path syntax does not support spaces between operators and values, but values enclosed in single quotes can include them (i.e. name$eq'value with spaces').

Comma-Separated Lists for Multiple Associations

The RMA Path specifies a set of associations from a resource. The simplest form is a comma-separated list of association names. Association names are lower case and may be singular or plural depending on the type of association.

Code Block
probes,organism,chromosome

Nested Parentheses for Association Paths

Indicate multiple levels of association with nested parentheses. Follow multiple associations from a model by using commas.

Code Block
probes(orientation,predicted_sequence)

Square Brackets for Filters

Filter the resources that are included in the query results using square brackets following an association. Operators include equal ($eq), not equal ($ne), like ($li), greater than ($gt), less than ($lt), greater or equal ($ge) less or equal ($le) in ($in) and case-insensitive like ($il).

...

Code Block
http://api.brain-map.org/api/v2/data/Organism/query.xml?criteria=[name$il'*human*'][id$ne15]
http://api.brain-map.org/api/v2/data/Gene/query.xml?criteria=[acronym$il'abat']&include=organism

Double Colon for Axis

The double colon (::) operator can be used to change the axis of an RMA query. The five defined axes are attribute::, model::, service::, pipe:: and rma::. The double colon axis operator is combined with an id to create a single step along the axis. Examples include service::differential, pipe::list, model::Gene, and rma::options. Each axis behaves slightly differently. They can be used in combination to form a service pipeline.

...