Cheat Sheet - Concepts Outlined in this Tutorial
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 | 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="c2bae04c-6999-4dbd-a112-352247a3b3cd"><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="d5830ca6-f354-4966-a4df-52e81681b20c"><ac:plain-text-body><![CDATA[ | filter | [enEN: field] |
|
| [value1enEN:,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="9001b336-1ad3-4f84-9938-27b7db87c748"><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="c605012a-09b8-4472-ae75-2a2f60d43e44"><ac:plain-text-body><![CDATA[ | |
filter | [enEN: field] |
|
| [enEN:value1,|value2…] |
| Filter fields for multiple 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="5284c044-6de4-491a-81e9-e96f08670e42"><ac:plain-text-body><![CDATA[ | filter | [enEN:field] |
| % | [enEN:value] | % | Filer Filter "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="8eba5536-a7d9-4a3f-9dd8-6e9c5828348d"><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 »"Nunmber" |
limit |
|
|
| Starting index, NombreNumber |
| Limit the result to "Number" from the "Index" |