Sugar Network/API: Difference between revisions

Line 63:

:* {{Code|offset}}, ''int'' start index to return entries from;

:* {{Code|limit}}, ''int'' do not return more then specified value;

:* {{Code|query}}, ''str'' search request in [http://xapian.org/docs/queryparser.html Xapian] notation;

:* {{Code|query}}, ''str'' search request in [http://xapian.org/docs/queryparser.html Xapian] notation with the following additions:

:** if property is boolean, integer or datetime, it supports searching by ranges: {{Code|<PROP>:[<START>]..[<END>]}};

:** the statement {{Code|<nowiki><PROP>:=["]<VALUE>["]</nowiki>}} means {{Code|(<THE-REST_QUERY>) AND <EXACT-PROP-SEARCH>}} with searching {{Code|PROP}} for exact {{Code|VALUE}}; it is different to regular {{Code|<PROP>:<VALUE>}} where {{Code|VALUE}} might be a substring of exact {{Code|PROP}} value;

:* {{Code|properties}}, ''str'' coma separated list of ''RESOURCE'' properties to return; by default, return only {{Code|guid}} property;

:* {{Code|order_by}}, ''str'' property to sort the resulting list by; if starts with the {{Code|-}}, the order is descending, otherwise it is ascending.

@@ Line 63: / Line 63: @@
 :* {{Code|offset}}, ''int''<br>start index to return entries from;
 :* {{Code|limit}}, ''int''<br>do not return more then specified value;
-:* {{Code|query}}, ''str''<br>search request in [http://xapian.org/docs/queryparser.html Xapian] notation;
+:* {{Code|query}}, ''str''<br>search request in [http://xapian.org/docs/queryparser.html Xapian] notation with the following additions:
+:** if property is boolean, integer or datetime, it supports searching by ranges: {{Code|<PROP>:[<START>]..[<END>]}};
+:** the statement {{Code|<nowiki><PROP>:=["]<VALUE>["]</nowiki>}} means {{Code|(<THE-REST_QUERY>) AND <EXACT-PROP-SEARCH>}} with searching {{Code|PROP}} for exact {{Code|VALUE}}; it is different to regular {{Code|<PROP>:<VALUE>}} where {{Code|VALUE}} might be a substring of exact {{Code|PROP}} value;
 :* {{Code|properties}}, ''str''<br>coma separated list of ''RESOURCE'' properties to return; by default, return only {{Code|guid}} property;
 :* {{Code|order_by}}, ''str''<br>property to sort the resulting list by; if starts with the {{Code|-}}, the order is descending, otherwise it is ascending.