En poursuivant votre navigation sur ce site, vous acceptez l’utilisation de Cookies pour réaliser des statistiques de visites.

09 54 46 51 10

du lundi au vendredi de 08h à 19h

/fetch


Permets la récupération de données depuis la base de données.

Un tableau d'objet ayant les paramètres ci-dessous et encodé au format JSON doit être passé en paramètre POST.

Exemple :
[
  { "recordType": "contact", "id": 40244 }, 
  { "recordType": "contactField", "query": "contact = 40244" },
  ...
]

Paramètres

Liste des paramètres pouvant être passés aux objets du tableau de données.

recordType

Le type d'enregistrement à récupérer.

id

Permets de récupérer un enregistrement à partir de son id.

Exemple :
curl -i \
  -H 'Authorization: 402ee586ead7bd13726c3e533a00e18d767418d843c902d5ac7e961c4c772e77' \
  -H 'Accept: application/vnd.gestixi.v1' \
  -d '[{ "recordType": "contact", "id": 40244 }]' \
  https://api.gestixi.com/fetch ; echo
Response :
[
  {
    "recordType":"contact",
    "id":39488,
    "dataHash":{"etag":"2015-02-04 20:07:36","id":39488,"creationTimestamp":"2014-12-12 12:02:53","lastChangeTimestamp":"2014-12-12 12:02:53","userCreator":834,"lastChangeUser":834,"prefix":"","number":1,"type":1,"username":"","lastName":"BADIA","firstName":"Nicolas","company":"GestiXi","isCompany":1,"email":"nicolas@gestixi.com","phone":"","picture":"","fund":0,"newsletter":1,"rfid":"","status":0,"lang":"fr","fullName":"Nicolas BADIA","contactField":[180852],"subscription":null,"commercialDocument":null,"file":null,"cart":null}
  }
]

query

Permet de recherches des enregistrements en utilisant le language de requète.

Exemple :
curl -i \
  -H 'Authorization: 402ee586ead7bd13726c3e533a00e18d767418d843c902d5ac7e961c4c772e77' \
  -H 'Accept: application/vnd.gestixi.v1' \
  -d '[{ "recordType": "item", "query": "category.designation CONTAINS \"Boutique\"" }]' \
  https://api.gestixi.com/fetch ; echo
Response :
[{"recordType":"item","dataHashes":[...]}]

parameters

Un tableau contenant des paramètres à remplacer.

Les valeurs %@ seront remplacées dans l'ordre par les valeurs de ce tableau.

Exemple :
curl -i \
  -H 'Authorization: 402ee586ead7bd13726c3e533a00e18d767418d843c902d5ac7e961c4c772e77' \
  -H 'Accept: application/vnd.gestixi.v1' \
  -d '[{ "recordType": "item", "query": "category.designation CONTAINS %@", "parameters": ["Boutique"] }]' \
  https://api.gestixi.com/fetch ; echo
Response :
[{"recordType":"item","dataHashes":[...]}]

start

L'index du premier enregistrement à renvoyer.

length

Le nombre d'enregistrements à renvoyer

orderBy

Paramètre optionnel. Le nom du champ à utiliser pour trier les résultats de la requête. " DESC" ou " ASC" peut être ajouté à la fin pour trier de manière ascendante ou descendante..

Exemple :
curl -i \
  -H 'Authorization: 402ee586ead7bd13726c3e533a00e18d767418d843c902d5ac7e961c4c772e77' \
  -H 'Accept: application/vnd.gestixi.v1' \
  -d '[{ "recordType": "contact", "start": 0, "length": 20, "orderBy": "id DESC" }]' \
  https://api.gestixi.com/fetch ; echo
Response :
[{"recordType":"contact","dataHashes":[...]}]