...
| Bloc de code | ||
|---|---|---|
| ||
{
"companyCode": "RHOL",
"entityName": "product",
"srvExport": 0,
"srvAttrib": 0,
"limit": 20,
"offset": 0,
"returnFields": [
{
"fieldName": "description",
"aliasName": "designation"
},
{
"fieldName": "productfamily_ID"
},
{
"fieldName": "product_ID",
"aliasName": "productCode"
},
{
"fieldName": "saleMultiple"
}
],
"filterFields": [
{
"companyCode": "COMPANY",
"filterKey": "branchOfficeKey",
"fieldName": "branchoffice_ID",
"operator": "Equal",
"filterValues": [
"Office"
]
},
{
"filterKey": "descriptionKey",
"fieldName": "description",
"operator": "StartWith",
"filterValues": [
"BOUTON FK"
]
},
{
"filterKey": "saleMultipleKey",
"fieldName": "saleMultiple",
"ifNullValue": 1,
"operator": "GreaterThanOrEqual",
"filterValues": [
5
]
}
],
"filterGroups": [
{
"groupLogicalOperator": "AND",
"filterKeys": [
"descriptionKey",
"saleMultipleKey"
],
"groupKeys": [
"subGroup"
]
},
{
"groupKey": "subGroup",
"groupLogicalOperator": "OR",
"filterKeys": [
"descriptionKey",
"saleMultipleKey"
]
}
],
"sortFields": [
{
"fieldName": "description",
"sortOrder": "Descending"
},
{
"fieldName": "defaultPrice",
"sortOrder": "Ascending"
}
]
} |
...
companyCode (optionnel) : code de la société pour le filtrage des données. Par défaut, le code société associé à l'utilisateur connecté est utilisé.
entityName (obligatoire) : nom de la table (sans « sw_data_ »).
limit (optionnel) : limite le nombre d’enregistrements renvoyés dans le document. Par défaut, limité à 1000 enregistrements.
offset (optionnel) : offset du premier enregistrement à retourner dans le document. Par défaut, les lignes retournées commencent à l'index 0.
srvAttrib (optionnel) : permet de filtrer les résultats sur la valeur du champ srvAttrib (suppression logique). Par défaut, seuls les enregistrements pour lesquels srvAttrib est égal à zéro sont retournés.
srvExport (optionnel) : permet de filtrer les résultats sur la valeur du champ srvExport (à exporter).
returnFields (obligatoire) : liste des champs à retourner.
fieldName (obligatoire) : nom du champ à sélectionner.
aliasName (optionnel) : nom du champ à retourner dans le document.
filterFields (optionnel) : liste des champs sur lesquels il faut effectuer un filtrage de données.
companyCode (optionnel) : permet d’indiquer un code société dans le cas où le filtre est basé sur une table étrangère.
filterKey (optionnel) : permet d'identifier un filtre pour être utilisé ensuite dans un groupe de plusieurs filtres.
fieldName (obligatoire) : nom du champ à filtrer.
ifNullValue (optionnel) : valeur par défaut dans le filtre si la valeur n'est pas définie en base.
operator (obligatoire) : défini l'opérateur à appliquer dans le filtrage du champ. Les opérateurs possibles dépendent du type de champ, se référer à la matrice ci-dessous.
filterValues (obligatoire/optionnel en fonction de l'opérateur) : défini la ou les valeurs à utiliser dans le filtrage du champ. Pour certains opérateurs, ce champ doit rester vide.
filterGroups (optionnel) : liste des groupes de filtres sur lesquels il faut effectuer un filtrage de données.
groupKey (optionnel) : permet d'identifier un groupe pour être utilisé ensuite en tant que sous-groupe dans un groupe. Un groupe peut être déclaré dans plusieurs sous-groupes. Il n'est pas possible de faire des boucles infinies. Si les groupes sont utilisés, au minimum un groupe ne doit appartenir à aucun sous-groupe (groupe racine).
groupLogicalOperator (optionnel) : permet de définir l'opérateur logique à utiliser entre les filtres du groupe : valeurs possibles "AND" / "OR". Par défaut, l'opérateur "AND" est utilisé.
filterKeys (obligatoire) : liste des identifiants de filtre à inclure dans le groupe. Cette liste est automatiquement dédoublonnée (une seule occurance de filtre par groupe).
groupKeys (optionnel) : liste des identifiants de groupe à inclure dans le groupe (sous-groupes). Cette liste est automatiquement dédoublonnée (une seule occurance de sous-groupe par groupe).
sortFields (optionnel) : liste des champs sur lesquelles faire le tri des résultats retournés. Le tri est fait dans l'ordre de déclaration des champs.
fieldName (obligatoire) : nom du champ à trier.
sortOrder (optionnel) : sens du tri à appliquer : valeurs possibles "Ascending" / "Descending". Par défaut, le sens "Ascending" est utilisé.
Matrice des opérateurs autorisés en fonction du type de champ (est précisé les données à fournir en tant que valeur pour le filtre) :
Integer / Double / DateTime :
Undefined : aucune valeur de filtre
Defined : aucune valeur de filtre
Equal : une seule valeur de filtre
Different : une seule valeur de filtre
LessThanOrEqual : une seule valeur de filtre
LessThan : une seule valeur de filtre
GreaterThanOrEqual : une seule valeur de filtre
GreaterThan : une seule valeur de filtre
InList : une ou plusieurs valeurs de filtre
String :
Undefined : aucune valeur de filtre
Defined : aucune valeur de filtre
Equal : une seule valeur de filtre
Different : une seule valeur de filtre
StartWith : une seule valeur de filtre
InList : une ou plusieurs valeurs de filtre
Boolean :
Undefined : aucune valeur de filtre
Defined : aucune valeur de filtre
IsTrue : aucune valeur de filtre
IsFalse : aucune valeur de filtre
Blob :
Undefined : aucune valeur de filtre
Defined : aucune valeur de filtre
ForeignKey :
Undefined : aucune valeur de filtre
Defined : aucune valeur de filtre
Equal : une seule valeur de filtre
Different : une seule valeur de filtre
InList : une ou plusieurs valeurs de filtre
...