Last modified 19 months ago Last modified on 27/07/10 15:29:36

Query XML Format

Here is an example of the XML format for our path query API:

<query name="queryName" model="modelName" view="Gene.name Gene.proteins.name" sortOrder="Gene.name">
    <constraint path="Gene.length" op="&gt;" value="500"/>
    <pathDescription path="Gene.name" description="The gene name"/>
    <join path="Gene.proteins" status="OUTER"/>
</query>

The Query Tag

The enclosing tag of an XML query is the query tag, which can contain several attributes:

  • name - the name of the query, which will be used when saving the query.
  • model - the name of the data model.
  • view - a space-separated list of paths of data to output.
  • sortOrder - a space-separated list of paths to sort the data by.
  • longDescription - a text description.
  • constraintLogic - the logic that combines the constraints defined elsewhere in the query.