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="b74d8a028eaf1226-1ec1d164-4897411c-a9138390-f38bf693505aa34ca712a766"><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="bd8f830d730ec6d3-2355a485-490d40d8-8f798c17-b85a634d77eb1b70f36c8f42"><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="61c885831c29fd11-627bf6c9-4d314051-9be395cf-2b2c55871d3d458880172756"><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="0f7e5fe5788be1ef-912a9f89-4ed04443-afce917a-bb08e7c7b44e35cea3735636"><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="89d524c6dce7d800-0d911baf-45654dbc-9aa7a9d8-b0e4b001262ca427e57aa00a"><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="5c9302aad8713d56-5b0b02ce-42274c35-bc21a574-370fe1a350d2b53bb47634bc"><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" |