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="6cb649b0-0ff0-43f3-ad31-2b2f8ea39276"><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="dd31c387-3b36-4470-a5ec-c13235fff2d1"><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="abbc390f-b201-41b5-b5b2-7714bedd8fdd"><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="2dbe5f4a-dcee-46b6-b98e-d15aaad64954"><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="0914afff-fdf4-42bd-937c-48975aa18783"><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="110647cd-8999-4b70-971e-8e97342b5547"><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" |