Ressource (sdata)
De Wiki1000
(Différences entre les versions)
(→Modification d'entité (PUT)) |
(→Suppression d'entité (DELETE)) |
||
| Ligne 238 : | Ligne 238 : | ||
<pre> | <pre> | ||
DELETE http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018') | DELETE http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018') | ||
| + | Response: 200 OK | ||
</pre> | </pre> | ||
[[Category:SData]] | [[Category:SData]] | ||
Version du 22 décembre 2020 à 09:47
Sommaire |
Requête sur les entités (GET)
GET http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000000285DAE')
Response: 200 OK
{
"$baseUrl":"http://localhost:8080/sdata/l1000/gentiers/-/",
"$title":"TTiers - -",
"$updated":"2020-12-22T08:10:09.740Z",
"$resources":[
{
"$url":"TTiers('9D33A23CFA6A005500F6000000285DAE')",
"$title":"ABI Jardin",
"$updated":"2010-03-23T15:37:46.000Z",
"$etag":"9D33A23CFA6A005500F6000000285DAE-000002C60000421C",
"$key":"9D33A23CFA6A005500F6000000285DAE",
"$baseUrl":"http://localhost:8080/sdata/l1000/GenTiers/-/",
"stamp":"000002C60000421C",
.... Attribute list ...
}
]
}
Paramètres de la requête
| Paramètre | valeur | Usage |
|---|---|---|
| select | liste d'attributs séparés par des virgules | Liste des attributs à retourner |
| where | Expression objet | Filtre de la requête |
| orderBy | Attribut de tri | Ordre de tri de la requête |
| count | Taille de page | Pagination : Taille de page |
| startIndex | Index de page | Pagination par page : Numéro de page (0 première) |
| startKey | Valeur de clé ou de tri | Pagination par clé : Clé de position |
| keyDirection | lt,le,gt,ge | Pagination par clé : direction par rapport à startKey |
Les valeurs passées en paramètre doivent être encodées en HTML
Exemple :
where=code eq 'ABI 007'
doit être encodée en :
where=code%20eq%20%27ABI%20007%27
Select
GET http://localhost:8080/sdata/gentiers/ttiers?select=code,caption
Filtre
Opérateurs:
| opérateur | équivalence | exemple | encoded |
|---|---|---|---|
| eq | = | where=code eq 'ABI 007' | where=code%20eq%20%27ABI%20007%27 |
| neq | <> | ||
| lt | < | ||
| le | <= | ||
| gt | > | ||
| ge | >= | ||
| like | like | where=code like 'ABI %' | where=code%20like%20%27ABI %25%27 |
| in | in |
Valeurs des paramètres:
Les valeurs des paramètres sont passées en littérale
| Type de donnée | exemple |
|---|---|
| Chaîne | code eq 'xxx' |
| boolean | flag eq true |
| numérique | value eq 1 |
| flottant | value eq 1.0 |
| date | $updated > '2020-12-21T00:00:00' |
Ordre de tri
Tri ascendant :
orderby=code
Tri descendant :
orderby=code%20desc
GET http://localhost:8080/sdata/gentiers/ttiers?orderBy=code%20desc /pre> ====Pagination par page==== Utiliser orderBy, count et startIndex <pre> GET http://localhost:8080/sdata/gentiers/ttiers?type=application/json&select=code&orderby=code&count=10&startIndex=0 GET http://localhost:8080/sdata/gentiers/ttiers?type=application/json&select=code&orderby=code&count=10&startIndex=1 GET http://localhost:8080/sdata/gentiers/ttiers?type=application/json&select=code&orderby=code&count=10&startIndex=2 ...
Pagination par clé
Utiliser orderBy, startKey et keyDirection
GET http://localhost:8080/sdata/gentiers/ttiers?type=application/json&select=code&orderby=code&count=10&startKey=1B28EFFFF1C3000200F6000000230893&keyDirection=lt
Création d'entité (POST)
POST http://localhost:8080/sdata/gentiers/ttiers
Request:
{
"code":"SYFRE1",
"caption":"syfre 1",
"sitesList":[
{
"code":"SITE1",
"caption":"site1 de syfre1",
"adresse":{
"nomRueVoie":"rue de la pompe",
"ville":"Clichy",
"codePostal":"92100",
"pays":{
"$key":"9D33A23CFA6A005500150000001700FD"
}
}
}
]
}
Response: 200 OK
{
"$resources": [
{
"$key": "9D33A23CFA6A005500F6000001E20022",
"$url": "http://localhost:8080/sdata/l1000/gentiers/-/TTiers('9D33A23CFA6A005500F6000001E20022')",
... attribute list ...
}
]
}
Modification d'entité (PUT)
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Request:
{
"codeSIRET":"12345678"
}
Response: 200 OK
[
{
.... resource modified ...
}
]
Suppression d'entité (DELETE)
DELETE http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
Response: 200 OK
