« Ressource (sdata) » : différence entre les versions

De Wiki1000
Aucun résumé des modifications
Ligne 1 : Ligne 1 :


==Requête sur les entités SDATA==
==Requête sur les entités (GET)==
<pre>
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 ...
      }
  ]
}
</pre>


===Paramètres de la requête===


{|class="wikitable"
{|class="wikitable"
Ligne 9 : Ligne 31 :
!Usage
!Usage
|-
|-
|filter
|select
|liste d'attributs séparés par des virgules
|Liste des attributs à retourner
|-
|where
|Expression objet
|Expression objet
|Filtre de la requête
|Filtre de la requête
Ligne 32 : Ligne 58 :
|lt,le,gt,ge
|lt,le,gt,ge
|Pagination par clé : direction par rapport à startKey
|Pagination par clé : direction par rapport à startKey
|-
|select
|liste d'attributs séparés par des virgules
|Liste des attributs à retourner
|}
|}


Ligne 48 : Ligne 70 :
  where=code%20eq%20%27ABI%20007%27
  where=code%20eq%20%27ABI%20007%27


===Filtre===
====Select====
<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?select=code,caption
</pre>
 
====Filtre====


'''Opérateurs:'''
'''Opérateurs:'''
Ligne 125 : Ligne 152 :
|}
|}


===Ordre de tri===
====Ordre de tri====


Tri ascendant :
Tri ascendant :
Ligne 135 : Ligne 162 :
  orderby=code%20desc
  orderby=code%20desc


===Pagination par page===
<pre>
GET http://localhost:8080/sdata/gentiers/ttiers?orderBy=code%20desc
/pre>
 
====Pagination par page====


Utiliser orderBy, count et startIndex
Utiliser orderBy, count et startIndex


<pre>
<pre>
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=0
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=1
http://localhost:8080/sdata/gentiers/ttiers?type=application/json&select=code&orderby=code&count=10&startIndex=2
GET http://localhost:8080/sdata/gentiers/ttiers?type=application/json&select=code&orderby=code&count=10&startIndex=2
   ...
   ...
</pre>
</pre>
===Pagination par clé===
 
====Pagination par clé====


Utiliser orderBy, startKey et keyDirection
Utiliser orderBy, startKey et keyDirection


<pre>
<pre>
  http://localhost:8080/sdata/gentiers/ttiers?type=application/json&select=code&orderby=code&count=10&startKey=1B28EFFFF1C3000200F6000000230893&keyDirection=lt
GET http://localhost:8080/sdata/gentiers/ttiers?type=application/json&select=code&orderby=code&count=10&startKey=1B28EFFFF1C3000200F6000000230893&keyDirection=lt
</pre>
 
==Création d'entité (POST)==
<pre>
POST http://localhost:8080/sdata/gentiers/ttiers
{
  "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"
            }
        }
      }
  ]
}
</pre>
 
==Modification d'entité (PUT)==
<pre>
PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
{
"codeSIRET":"12345678"
}
</pre>
 
==Suppression d'entité (DELETE)==
<pre>
DELETE http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
</pre>
</pre>


[[Category:SData]]
[[Category:SData]]

Version du 22 décembre 2020 à 08:41

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
{
   "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"
            }
         }
      }
   ]
}

Modification d'entité (PUT)

PUT http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')
{
"codeSIRET":"12345678"
}

Suppression d'entité (DELETE)

DELETE http://localhost:8080/sdata/gentiers/ttiers('9D33A23CFA6A005500F6000001E20018')