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="5cf96e826a4d84aa-4e6cf290-40544c35-8ef99293-d49596cc070209b173d48df7"><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="a8c769db5596bcd1-84437347-40d64271-8159a7f3-d008d48968e983991363335f"><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="85fff78ef99f6ca8-d2a470c0-4422498c-b4eda12f-7e47fdbbad454dcaba58653f"><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="d05f356fec3fd862-ad92773f-459b48ae-a40aa779-b209e7c5b07c90ffcca10818"><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="4735d9ba1efa399a-45e828bb-43f94aa9-bbff8f77-fef5de16ba525d59e1f1836c"><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="d56279a8f57d9b3e-e9fd62da-4b454d41-af24831e-ac9c38f4858ac5ac5db6f213"><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

...