Sugar Network/API: Difference between revisions

Line 56:

Delete the specified ''RESOURCE'' object. The real destroying won't happen, the object will be hidden. The garbage collection of hidden objects will be processed by Network administrators. By default, might be called only by ''RESOURCE'' creator.

GET /<RESOURCE>?offset=<>&limit=<>[&query=<>][&properties=<PROP>[,..]][&order_by=<nowiki>[+|-]</nowiki>~~<PROP>[,..]][&group_by=~~<PROP>]

GET /<RESOURCE>?offset=<>&limit=<>[&query=<>][&properties=<PROP>[,..]][&order_by=<nowiki>[+|-]</nowiki><PROP>]

Find ''RESOURCE'' objects.

Line 65:

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

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

:* {{Code|order_by}}, ''str'' ~~coma separated list of ''RESOURCE'' properties~~ to sort the resulting list; if ~~an property~~ starts with the {{Code|-}}, the order is descending, otherwise it is ascending;

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

:* {{Code|group_by}}, ''str'' a property name to group resulting list by; if was specified, every resulting list item will contain {{Code|grouped}} key with a number of entries that are represented by the current one.

Sends:

@@ Line 56: / Line 56: @@
 Delete the specified ''RESOURCE'' object. The real destroying won't happen, the object will be hidden. The garbage collection of hidden objects will be processed by Network administrators. By default, might be called only by ''RESOURCE'' creator.
-  GET /<RESOURCE>?offset=<>&limit=<>[&query=<>][&properties=<PROP>[,..]][&order_by=<nowiki>[+|-]</nowiki><PROP>[,..]][&group_by=<PROP>]
+  GET /<RESOURCE>?offset=<>&limit=<>[&query=<>][&properties=<PROP>[,..]][&order_by=<nowiki>[+|-]</nowiki><PROP>]
 Find ''RESOURCE'' objects.
@@ Line 65: / Line 65: @@
 :* {{Code|query}}, ''str''<br>search request in [http://xapian.org/docs/queryparser.html Xapian] notation;
 :* {{Code|properties}}, ''str''<br>coma separated list of ''RESOURCE'' properties to return; by default, return only {{Code|guid}} property;
-:* {{Code|order_by}}, ''str''<br>coma separated list of ''RESOURCE'' properties to sort the resulting list; if an property starts with the {{Code|-}}, the order is descending, otherwise it is ascending;
+:* {{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.
-:* {{Code|group_by}}, ''str''<br>a property name to group resulting list by; if was specified, every resulting list item will contain {{Code|grouped}} key with a number of entries that are represented by the current one.
 Sends: