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 |
postXml |
putXml |
|
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="a991cdc8-3569-4eda-a9cd-8d55b03d2063"><ac:plain-text-body><![CDATA[ |
display |
|
|
|
[enEN: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="2a1d042a-55b8-4927-88e9-be6dbba6e210"><ac:plain-text-body><![CDATA[ |
filter |
[enEN: field ] |
|
|
[value1 |
enEN: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="9cb19029-13d3-4403-b83e-3a8ed6d0ca99"><ac:plain-text-body><![CDATA[ |
filter |
[enEN: field ] |
|
|
[enEN: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="3491d624-0f43-483f-8975-422720036592"><ac:plain-text-body><![CDATA[ |
filter |
[enEN: field ] |
|
|
[enEN: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="bae13e89-f180-476d-9ab6-37f057a856b6"><ac:plain-text-body><![CDATA[ |
filter |
[enEN:field] |
|
% |
[enEN: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="84cede23-f639-4f6d-90b7-5184a0cb42c8"><ac:plain-text-body><![CDATA[ |
sort |
|
|
|
[enEN: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" |