Cheat Sheet - Concepts Outlined in this Tutorial
Method
To help you get started with web service, here's a little memo of techniques used in this tutorial.
|
|
|
|
|
Method parameters |
|
|
|
|
---|---|---|---|---|---|---|---|---|---|
|
REST |
|
Method |
|
url |
resource |
id |
xml |
|
C |
POST |
|
add |
|
X |
X |
|
X |
|
R |
GET |
|
get |
|
X |
X |
X |
|
|
U |
UPDATE |
|
edit |
|
X |
X |
X |
X |
|
D |
DELETE |
|
delete |
|
X |
X |
X |
|
If the URL parameter is specified, no other setting can be used and vice versa.
Options
Key |
Key suffix |
|
prefix |
Value |
Suffix |
Description |
||
---|---|---|---|---|---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="322b81a4-2179-4c02-b39d-504421dadd3e"><ac:plain-text-body><![CDATA[ |
display |
|
|
|
[field1,field2 …] |
|
Only display fields in brackets |
]]></ac:plain-text-body></ac:structured-macro> |
display |
|
|
|
full |
|
Display all fields |
||
Key |
Key suffix |
|
prefix |
Value |
Suffix |
Description |
||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="ad388c0c-74fe-4426-9735-82f4edeecfac"><ac:plain-text-body><![CDATA[ |
filter |
[ field ] |
|
|
[value1 |
value2] |
Filter "field" with value between 'value1 " and "value2" |
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="fd5ebd6b-79a2-40bb-b81e-bf9dd796eb92"><ac:plain-text-body><![CDATA[ |
filter |
[ field ] |
|
|
[value] |
|
Filter field with the value "value" |
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="11d538c3-238d-42a1-af0f-451a1484671b"><ac:plain-text-body><![CDATA[ |
filter |
[ field ] |
|
|
[value1,value2…] |
|
Filter fields for values specified between brackets |
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="ca7d783b-f53e-486b-a21b-2553c01a300c"><ac:plain-text-body><![CDATA[ |
filter |
[field] |
|
% |
[value] |
% |
Filer "columns" for values containing "value" |
]]></ac:plain-text-body></ac:structured-macro> |
Key |
Key suffix |
|
prefix |
Value |
Suffix |
Description |
||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="f8a0a131-a837-43db-8724-707d6b1cae11"><ac:plain-text-body><![CDATA[ |
sort |
|
|
|
[field1_ASC,field2_DESC,field3_ASC] |
|
Sort by field with the suffix _ASC _DESC or in the order |
]]></ac:plain-text-body></ac:structured-macro> |
sort |
|
|
|
full |
|
show all fields |
Key |
Key suffix |
|
prefix |
Value |
Suffix |
Description |
---|---|---|---|---|---|---|
limit |
|
|
|
Number |
|
Limit the result to « Nombre » |
limit |
|
|
|
Starting index, Nombre |
|
Limit the result to "Number" from the "Index" |