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="c7815ecf-2a07-4b1a-b410-152e50ff9752"><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="1f8ffd76-e012-4202-a4e9-72a332521fa1"><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="20129640-70ff-4c59-909b-71178c72c5d3"><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="f46943ec-9146-4dff-9572-f451446a03a3"><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="6e2d4cb6-f8cb-49d4-86d2-d5f46524e9d2"><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="f27a6266-b131-4f85-99f9-78bdb09116ac"><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" |