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 | postXmlxml | putXmlxml |
|
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="61144bdec608924f-5b1cb0c8-4c5a42d7-99708ced-a57f68b95804f4c15f4413d9"><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="f4393304e1183fe5-2f518e6d-464d4418-bdec8e4f-7f338fff48c50790a81fcbd9"><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="001a42508041b70a-2035e325-4a4645d7-bd939364-af9afe31154d2231c832ac1e"><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="4bd46fb6091082f7-233fe9b4-46a64035-814e80c4-3ad08fedab80245d3cb98861"><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="a6422947ba115376-2fbd954c-464344a7-8bdba915-01a35b1571d07c6509135aa9"><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="b43e08781c5d2697-067de875-46e44986-ba058ea0-f5182e5e1b62546fb4b2eceb"><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 »« Nombre » |
limit |
|
|
| Starting index, Nombre |
| Limit the result to "Number" from the "Index" |