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 |
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="e9586272-fbe3-4e9f-87fb-a75645de176a"><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="d0afe197-06f3-4e69-822d-0f3dd3dbe8fa"><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="5798cbc3-9cbb-4c90-8f44-5397dd384984"><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="5f7c2dd9-f8a6-4c9f-a579-6f3879565faa"><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="8e253235-639c-487b-8c39-09cc66eafb09"><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="e35cbcbe-2022-4edb-9e75-1c990fb58acd"><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" |