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="cba44e4f-e6a2-407c-a111-7f86b8609366"><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="809d865a-f752-4524-b4db-b10d2179cd4b"><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="1b135650-9d0a-4fc0-be07-99a94e7ce12c"><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="ca4e9752-2b14-4073-a57c-7ce879e1d75d"><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="28da0d55-da4e-47f6-bb0b-d718f4cf5090"><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="4720f1a2-7cc9-4fc1-a9a2-0a4b3bdb28c0"><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 « Nombre »

limit

 

 

 

Starting index, Nombre

 

Limit the result to "Number" from the "Index"