Mémento - Notions énoncées dans ce tutoriel
Méthode
Afin de vous aider dans vos premiers pas avec le service web, voici un petit mémo des techniques utilisés dans ce tutoriel.
|
|
|
|
|
Paramètre(s) de la méthode |
|
|
|
|---|---|---|---|---|---|---|---|---|
|
REST |
|
Méthode |
|
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 |
|
Si le paramètre url "est" spécifié, aucun autre paramètre ne peut être utilisé et vice versa.
L'utilisation des images se fait via un paramètre nommé "image".
Options
Les options ne fonctionne que pour la récupération d'une liste d'élément,
Exemple :
/api/products/?filter...
/api/products/1?filter...
Clé |
Suffixe de clé |
|
préfixe |
Valeur |
Suffixe |
Description |
||
|---|---|---|---|---|---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="22046bbb-d78e-4ed7-b96e-864fc13747b3"><ac:plain-text-body><![CDATA[ |
display |
|
|
|
[champ1,champ2 …] |
|
N'afficher que les champs entre crochet, fonctionne également pour les association |
]]></ac:plain-text-body></ac:structured-macro> |
display |
|
|
|
full |
|
Afficher tous les champs |
Clé |
Suffixe de clé |
|
préfixe |
Valeur |
Suffixe |
Description |
||
|---|---|---|---|---|---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="d576d3eb-319b-4ecc-bf00-fb10d72df73d"><ac:plain-text-body><![CDATA[ |
filter |
[champ] |
|
! |
[valeur] |
|
Exclu les valeurs entre crochet |
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="ce3aaf1d-7e15-40f3-b703-a793b023f076"><ac:plain-text-body><![CDATA[ |
filter |
[champ] |
|
< |
[valeur] |
|
Filtrer par valeurs inférieures à la valeur entre crochet |
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="95a645b3-f068-4719-a237-c45733b05090"><ac:plain-text-body><![CDATA[ |
filter |
[champ] |
|
> |
[valeur] |
|
Filtrer par valeurs supérieures à la valeur entre crochet |
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="028023ca-17e1-4946-a818-45bbafd59c0b"><ac:plain-text-body><![CDATA[ |
filter |
[champ] |
|
|
[valeur] |
|
Filtrer champ par la valeur "valeur" |
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="98f0fc15-f3b1-423d-8da9-c8fbed5c158c"><ac:plain-text-body><![CDATA[ |
filter |
[champ] |
|
|
[valeur1,valeur2…] |
|
Filtrer champ pour les valeurs spécifiées entre crochet |
]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="1234a294-138b-4948-a249-789f14ad19b7"><ac:plain-text-body><![CDATA[ |
filter |
[champ] |
|
% |
[valeur] |
% |
Filtrer "colonne" pour les valeurs contenant "valeur" |
]]></ac:plain-text-body></ac:structured-macro> |
Clé |
Suffixe de clé |
|
préfixe |
Valeur |
Suffixe |
Description |
||
|---|---|---|---|---|---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="6dd5ce3a-1f16-4287-a041-0e4082b4692f"><ac:plain-text-body><![CDATA[ |
sort |
|
|
|
[champ1_ASC,champ2_DESC,champ3_ASC] |
|
Trier par champ avec le suffixe _ASC ou _DESC selon l'ordre souhaité |
]]></ac:plain-text-body></ac:structured-macro> |
sort |
|
|
|
full |
|
Afficher tous les champs |
Clé |
Suffixe de clé |
|
préfixe |
Valeur |
Suffixe |
Description |
|---|---|---|---|---|---|---|
limit |
|
|
|
Nombre |
|
Limiter le résultat à "Nombre" |
limit |
|
|
|
Index de départ, Nombre |
|
Limiter le résultat à "Nombre" à partir de "Index" |