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 | xml | xml |
|
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="b79641c05a737a44-ddfaf383-41a94492-9c38b912-2fe6915a0e98d6a332d1fc72"><ac:plain-text-body><![CDATA[ | display |
|
|
| [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="a48daaf7c5c680eb-2e3a501e-4d124597-a8f882a9-f079f24f68e8ac4d47c9ef66"><ac:plain-text-body><![CDATA[ | filter | [ field ] |
|
| [value1 | 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="8fef3d7ba9b78629-a44a7a4c-44724a26-90e8a216-afd9f27fc3886bac1a363275"><ac:plain-text-body><![CDATA[ | filter | [ field ] |
|
| [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="fbc8ff4989af4ace-4ff019a0-42064e24-a26eb734-21f67e1e7a207252f88ef9c7"><ac:plain-text-body><![CDATA[ | filter | [ field ] |
|
| [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="4e7b995d4bb413b6-8480e526-486c42d1-966eb7b2-72bbbe3da2f1472eef12d370"><ac:plain-text-body><![CDATA[ | filter | [field] |
| % | [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="af8c6ba2be9ea66c-58225cef-4732432d-99fb96cd-423ba5985a001c51ea46e331"><ac:plain-text-body><![CDATA[ | sort |
|
|
| [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 |
...