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="d16fb1147670803f-c307a71c-403148b0-b492b9a0-a5188993433b505fe5f85d30"><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="ecc3e4cc1a4f4ed6-13b86565-45f946ff-8c0784a0-4b288681a22bc31b4d506e8f"><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="19b58233533bb105-242443f7-4d0d4bba-a2e385b8-530c624a13f8616c85a00f64"><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="1027341457630349-e5b5ba94-4869408f-b9479b56-63118e3e3387fa38a83e430c"><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="0c9861ee452a9b9a-325cacaf-447b4cb1-9b389c50-6f55cc2c9a0569c493e3426f"><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="160650812abe9e56-2c3a11e6-4ad842d0-84ad995b-dc16e9990a656db362c21e82"><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" |