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 |
|
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.
Key |
Key suffix |
|
prefix |
Value |
Suffix |
Description |
||
---|---|---|---|---|---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="fcd4499a-b4e8-4d31-9095-6fcb79cdfe1b"><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="806f1e55-f0fd-4945-bf0b-99a91ec041ad"><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="fcf95675-111c-4655-a4c7-83a77086e154"><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="7328b4aa-9919-48ce-b698-e2389d0bd099"><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="0b0dc6cb-c865-4c09-a54b-bf31c330e01d"><ac:plain-text-body><![CDATA[ |
filter |
[field] |
|
% |
[value] |
% |
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="b6bb11b9-3a18-4884-9512-e29888309734"><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 |
Key |
Key suffix |
|
prefix |
Value |
Suffix |
Description |
---|---|---|---|---|---|---|
limit |
|
|
|
Number |
|
Limit the result to "Nunmber" |
limit |
|
|
|
Starting index, Number |
|
Limit the result to "Number" from the "Index" |