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.
Key |
Key suffix |
|
prefix |
Value |
Suffix |
Description |
||
---|---|---|---|---|---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="39be5840-3d72-43dc-973c-3e216760c524"><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="efb6aeaa-eae0-480c-84f4-d000848b3920"><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="8319386f-22ee-45ae-a573-b378272bca00"><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="bc7b1e8c-cd46-4f3d-9592-9afa880ab7b2"><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="1ff5be3d-d59d-473e-a0df-4445026f85e6"><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="ffc633ae-0be4-449d-8b4d-e8cc64c59315"><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" |