WebHook Parameters

Résumé

Webhook un peu particulier qui permet de connaitre les paramètres et limites utilisés par les autres webhooks. Utilisation en lecture uniquement.

Tables

Les tables utilisées sont :

sw_data_basevariable : Table des variables

Critères d'activation

WHK_Parameters est défini dans la gestion des webhooks du studio.

Particularités

Pour l'instant trois paramètres sont retournés :

fileMaxSize (variable MobileDbFromFileMaxSize) : taille maximum en octets des fichiers que l'on peut uploader dans le webhook File (par défaut : 512 Ko). Cette valeur est également retournée dans la réponse du webhook File en mode DEFINITION.
maxElementAtOnce (variable Webhook.PUT.MaxElementAtOnce) : pour le mode PUT par lot, permet de définir le nombre maximum d'éléments qui peuvent être passés à la fois dans le tableau de données (par défaut : 10). Cette valeur est également retournée dans la réponse des webhooks en mode PUT.

pageSize (variable Webhook.LIST.ElementPerPage) : pour le mode LIST, permet de définir le nombre d'enregistrements à afficher par page (par défaut : 10). Cette valeur est également retournée dans la réponse des webhooks en mode LIST.

Fonctionnement

Appel du webhook :
Le json d'appel de ce webhook n'a besoin d'aucun paramètre. Un header avec les informations de base est suffisant.

{
  "header": 
    {
       "caller": how called the webhook ie.: infinity
       "callerVersion": version of the caller ie. 1.2.3.4
       "languageCode": FR, EN, DE, PT, ES, IT, FR-CA, EN-CA
       "userCode": user how called the webhook
       "callDateTime": initial call date/time, usefull when retries or whatever network issue
    }
}

Réponse du webhook :
La réponse aura 2 sections :

data : paramètres avec leurs valeurs
parameterList : description des paramètres

"response": {
  "data": 
  [{
    "parameter":
    {
      "fileMaxSize": "524288",
      "maxElementAtOnce": "10",
      "pageSize": "10"
    }
  }],
  "parameterList": 
  [{
    "parameters": 
    [{
      "parameterName": "fileMaxSize",
      "parameterCode": "MobileDbFromFileMaxSize",
      "parameterType": "int",
      "parameterLength": "",
      "parameterComment": "Maximum size in bytes of the file that can be uploaded"
    },
    {
      "parameterName": "maxElementAtOnce",
      "parameterCode": "Webhook.PUT.MaxElementAtOnce",
      "parameterType": "int",
      "parameterLength": "",
      "parameterComment": "Webhook : PUT - Max elements that can be passed at once"
    },
    {
      "parameterName": "pageSize",
      "parameterCode": "Webhook.LIST.ElementPerPage",
      "parameterType": "int",
      "parameterLength": "",
      "parameterComment": "Webhook : LIST - Elements per page"
    }]
  }]
}