Sugar Network/API: Difference between revisions

Line 31:

Create new ''RESOURCE'' object.

~~Sends~~:

Dictionary keys to send:

: ~~Resource~~ properties.

: ''RESOURCE'' properties.

~~Receives~~:

Dictionary keys to receive:

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

:* {{Code|guid}}, with globally unique identifier that specifies created object.

PUT /<RESOURCE>/<GUID>

Line 41:

Modify the specified ''RESOURCE'' object. By default, might be called only by ''RESOURCE'' creator.

~~Sends~~:

Dictionary keys to send:

: ~~Keys that need~~ to ~~be modified~~.

: ''RESOURCE'' properties to modify.

DELETE /<RESOURCE>/<GUID>

Line 62:

:* {{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.

~~Sends~~:

Dictionary keys to receive:

:* ~~A dictionary with ''RESOURCE'''s properties to restrict~~ the ~~resulting list.~~

:* {{Code|total}}, total number in requested query (the reply might contain only portion restricted by {{Code|limit}} request argument);

:* {{Code|result}}, an array of dictionaries with ''RESOURCE'' properties, dictionaries contain at least {{Code|guid}} property.

~~Receives:~~

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

GET /<RESOURCE>/<GUID>

Line 72:

Line 70:

Return ''RESOURCE'' properties the of particular object.

~~Receives~~:

Dictionary keys to receive:

:* ~~A dictionary with~~ ''RESOURCE'' properties that contains at least {{Code|guid}} property.

:* ''RESOURCE'' properties that contains at least {{Code|guid}} property.

=== Wiki actions ===

@@ Line 31: / Line 31: @@
 Create new ''RESOURCE'' object.
-Sends:
+Dictionary keys to send:
-: Resource properties.
+: ''RESOURCE'' properties.
-Receives:
+Dictionary keys to receive:
-:* {{Code|guid}}, ''str''<br>globally unique identifier that specifies created object;
+:* {{Code|guid}}, with globally unique identifier that specifies created object.
   PUT /<RESOURCE>/<GUID>
@@ Line 41: / Line 41: @@
 Modify the specified ''RESOURCE'' object. By default, might be called only by ''RESOURCE'' creator.
-Sends:
+Dictionary keys to send:
-: Keys that need to be modified.
+: ''RESOURCE'' properties to modify.
   DELETE /<RESOURCE>/<GUID>
@@ Line 62: / Line 62: @@
 :* {{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.
-Sends:
+Dictionary keys to receive:
-:* A dictionary with ''RESOURCE'''s properties to restrict the resulting list.
+:* {{Code|total}}, total number in requested query (the reply might contain only portion restricted by {{Code|limit}} request argument);
+:* {{Code|result}}, an array of dictionaries with ''RESOURCE'' properties, dictionaries contain at least {{Code|guid}} property.
-Receives:
-:* An array of dictionaries with ''RESOURCE'' properties, dictionaries contain at least {{Code|guid}} property.
   GET /<RESOURCE>/<GUID>
@@ Line 72: / Line 70: @@
 Return ''RESOURCE'' properties the of particular object.
-Receives:
+Dictionary keys to receive:
-:* A dictionary with ''RESOURCE'' properties that contains at least {{Code|guid}} property.
+:* ''RESOURCE'' properties that contains at least {{Code|guid}} property.
 === Wiki actions ===