Child pages
  • Cheat-sheet - Concepts outlined in this tutorial

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

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="a759b4cd-6b69-43f1-bec9-0bbecbfaa845"><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="5b80c31c-3994-4813-bb9a-243c48c633e2"><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="c3245fc1-c32a-4b05-a69c-3769080ff534"><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="0d2770c6-ec01-4996-8bf5-4a96408b13ee"><ac:plain-text-body><![CDATA[

filter

[field]

 

 

[value1,|value2…]

 

Filter fields for multiple 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="e80d38c5-7c4e-4ea8-92ec-a3779aaa1c27"><ac:plain-text-body><![CDATA[

filter

[field]

 

%

[value]

%

Filer 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="f6f7c546-f66c-4a75-a3c1-fe2682e1c1b6"><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 »"Nunmber"

limit

 

 

 

Starting index, NombreNumber

 

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