Sugar Network/API: Difference between revisions

Line 27:

Actions might be restricted for particular object, see the corresponding section for detailed information.

* {{Code|/<OBJECT>~~/'''create'''}}~~

POST /<OBJECT>

Create new ''OBJECT'' item.

Line 38:

:* {{Code|guid}}, ''str''<br>globally unique identifier that specifies created item;

/<OBJECT>/~~'''update'''?guid=~~<>

PUT /<OBJECT>/<GUID>

Modify the specified ''OBJECT'' item.

Line 45:

: Keys that need to be modified.

/<OBJECT>/~~'''delete'''?guid=~~<>

DELETE /<OBJECT>/<GUID>

Delete the specified ''OBJECT'' item. The real destroying won't happen, the item will be hidden. The garbage collection of hidden items will be processed by Network administrators.

/<OBJECT>~~/'''find'''~~?[query=<>][&offset=<>][&limit=<>][&properties=<PROP>[,..]][&order_by=<nowiki>[+|-]</nowiki><PROP>[,..]]

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

Find ''OBJECT'' items.

Line 66:

:* An array of dictionaries with ''OBJECT'' properties, dictionaries contain at least {{Code|guid}} property.

/<OBJECT>/~~'''get'''?guid=~~<>[&properties=<PROP>[,..]]

GET /<OBJECT>/<GUID>[?properties=<PROP>[,..]]

Return ''OBJECT'' properties the of particular item.

@@ Line 27: / Line 27: @@
 Actions might be restricted for particular object, see the corresponding section for detailed information.
-* {{Code|/<OBJECT>/'''create'''}}
+ POST /<OBJECT>
 Create new ''OBJECT'' item.
@@ Line 38: / Line 38: @@
 :* {{Code|guid}}, ''str''<br>globally unique identifier that specifies created item;
-  /<OBJECT>/'''update'''?guid=<>
+  PUT /<OBJECT>/<GUID>
 Modify the specified ''OBJECT'' item.
@@ Line 45: / Line 45: @@
 : Keys that need to be modified.
-  /<OBJECT>/'''delete'''?guid=<>
+  DELETE /<OBJECT>/<GUID>
 Delete the specified ''OBJECT'' item. The real destroying won't happen, the item will be hidden. The garbage collection of hidden items will be processed by Network administrators.
-  /<OBJECT>/'''find'''?[query=<>][&offset=<>][&limit=<>][&properties=<PROP>[,..]][&order_by=<nowiki>[+|-]</nowiki><PROP>[,..]]
+  GET /<OBJECT>?[query=<>][&offset=<>][&limit=<>][&properties=<PROP>[,..]][&order_by=<nowiki>[+|-]</nowiki><PROP>[,..]]
 Find ''OBJECT'' items.
@@ Line 66: / Line 66: @@
 :* An array of dictionaries with ''OBJECT'' properties, dictionaries contain at least {{Code|guid}} property.
-  /<OBJECT>/'''get'''?guid=<>[&properties=<PROP>[,..]]
+  GET /<OBJECT>/<GUID>[?properties=<PROP>[,..]]
 Return ''OBJECT'' properties the of particular item.