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

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="fab8d3bc-9259-4317-b7da-5315add0c905"><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="349e645a-2c9b-41dc-8a6a-a3b59913d7ef"><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="14e7ad21-e6f2-4a1e-b13a-f50a24e94208"><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="12cd8237-1a6c-4978-a0ab-c674cc669a14"><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="99c17973-acfc-484b-99dc-79096ec8169d"><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="75aa2961-1a67-4bdd-a1d6-8040c5f082c4"><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"