Vous pouvez filtrer la plupart de vos requêtes comme GET /Transactions ou GET /Contacts pour récupérer uniquement les données que vous voulez ou pour effectuer une recherche. Cela améliore la rapidité de vos requêtes. Pour ajouter un filtre à votre requête GET il faut l'ajouter au corps comme indiqué ci-dessous :
{
"Filter": {
"OperatorType": null,
"Operands": [
{
"OperatorType": null,
"Operands": [],
"PropertyName": null,
"Value": null,
"Comparison": null
}
],
"PropertyName": null,
"Value": null,
"Comparison": null
}
}
OperatorType: "and" or "or"
Operands : conditions à respecter
PropertyName : toute propriété d'un objet Docage, par exemple "FirstName" pour un Contact
Value : la valeur à comparer
Comparison : type de comparaison
| Comparison | Description |
|---|---|
| = | la propriété doit être égale à la valeur |
| <> | la propriété doit être différente à la valeur |
| > | la propriété doit être supérieure à la valeur |
| >= | la propriété doit être supérieure ou égale à la valeur |
| < | la propriété doit être inférieure à la valeur |
| <= | la propriété doit être inférieure ou égale à la valeur |
| contains | (string uniquement) la propriété doit contenir la valeur |
| notcontains | (string uniquement) la propriété ne doit pas contenir la valeur |
| startswith | (string uniquement) la propriété doit commencer par la valeur |
| endswith | (string uniquement) la propriété doit terminer par la valeur |
Note: Toutes les comparaisons de string sont insensibles à la casse.