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="d174eb67-f980-42fb-bec5-0f3bca6dee30"><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="888ac18e-8467-423b-9468-5d329f80e1a2"><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="c1424c66-58b0-4c9c-9245-3819a2db6d17"><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="a33ae374-583c-420f-b947-95c1b7d7cf7c"><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="385a47e2-34ab-46f8-bd06-c1c5798526f8"><ac:plain-text-body><![CDATA[ |
filter |
[field] |
|
% |
[value] |
% |
Filter "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="8884fa18-b506-4ab7-856c-eb045308ec02"><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 "Nunmber" |
limit |
|
|
|
Starting index, Number |
|
Limit the result to "Number" from the "Index" |