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="cb71aa00-d9f0-497c-a86d-aa31484480ee"><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="e5c883d8-b579-49e5-88d8-f5ff565da2e3"><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="c2554069-3409-427d-ab00-298f06817ec1"><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="79f7551c-97e5-44be-b43a-f7e3f0e5dd6a"><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="9385603b-b811-4ce9-b20b-40e7be53e611"><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="8c39a6df-e43f-4494-a1f3-57d0cbcac189"><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" |