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="520f24eeaf4951f8-692cb7d6-4d2446dc-aba8ac36-0d4a76577c3bdae5ff6ed2fa"><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="48151f94447d2bd9-0d21a2b3-411d4dad-831e9c8c-b94fd70ade4539b8b00cb91a"><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="080f0e085ed19b75-72759ab3-48b64f66-8dd1a79a-5511160dd16228e74b71b6b4"><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="fb37f060cdad6880-4ec95588-457a49e9-9c4b95e0-2debcbf6b7fb3cf60bfe07a0"><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="a4f2dec0af221553-3bcd8339-4c6447e1-bc3aa69c-62e492fab3177708a4cbfb46"><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="2ff9e1fa9fc10ad3-c898b695-4c1749cf-9ce487af-b3085810d04bd98b6e38301a"><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 |
...