Syntaxe d'interrogation dans les requêtes GET

Vous pouvez filtrer les objets que vous souhaitez récupérer en spécifiant une requête comme valeur du paramètre de recherche dans les requêtes GET. Les résultats sont renvoyés sous la forme d'une page d'objets dans un message de réponse.

Plusieurs pages de résultats peuvent être disponibles, mais la page renvoyée est celle que vous avez demandée à l'aide du paramètre page. Si vous souhaitez obtenir la page suivante, vous devez faire une nouvelle demande et incrémenter le numéro de page. Réglez le paramètre pageSize sur le nombre d'objets que vous souhaitez renvoyer dans le message de réponse.

La syntaxe de la requête pour le paramètre de recherche dans toute requête GET utilisant l'API Caseware Cloud est la suivante :

<Nom du champ><opérateur><valeur du champ>

En laissant la requête vide, tous les objets de la liste seront renvoyés.

<nom du champ> est le nom du champ de premier niveau sur lequel vous souhaitez opérer.

Remarque : Tous les noms de champs ne sont pas valables. Le champ doit être un type de données primitif tel que le texte, les nombres, les booléens et les dates. Les types de données complexes tels que les collections ou les objets ne peuvent pas faire l'objet d'une recherche.

Conseil : La plupart des champs (ou paramètres de requête) qui peuvent être utilisés pour formuler des requêtes (spécifiés comme valeur du paramètre de requête de recherche) sont décrits dans le schéma du corps de la requête dans l'opération POST Create pour l'objet que vous interrogez. Par exemple, si vous interrogez des entités, consultez l'opération POST Create pour les entités :

Opérateurs relationnels pris en charge

<opérateur> peut être l'un des éléments suivants :

• = (égal à)
• < (moins que)
• > (plus grand que)
• <> (pas égal)

<fieldValue> peut être n'importe quelle valeur scalaire, c'est-à-dire n'importe quelle valeur unique :

Pour le texte, c'est-à-dire tout champ dont le type de données est Chaîne, vous devez spécifier la valeur entre guillemets simples :

fieldName='test'

Pour les champs dont le type de données contient des caractères spéciaux tels que ' ou \ doit utiliser un caractère d'échappement (\) dans la requête de recherche :

fieldName='randomText's randomText'

Pour les champs dont le type de données est un nombre, indiquez la valeur numérique sans guillemets :

nomduchamp=123

Pour les champs dont le type de données est booléen,indique "true" ou "false" :

fieldName='true'

Pour les champs dont le type de données est la date, la date doit respecter ce format ISO :

fieldName='YYYY-MM-DDTHH:MM:SS:Z'

Opérateurs logiques pris en charge

Pour faciliter le filtrage des résultats, vous pouvez combiner deux ou plusieurs instructions de filtrage à l'aide des opérateurs logiques AND ou OR. L'opérateur AND a la priorité sur OR. Vous devez spécifier un espace avant et après l'opérateur :

<nom du champ><opérateur><valeur du champ> ET <nom du champ><opérateur><valeur du champ>

Exploiter	Description	Exemple
ET	Joindre deux ou plusieurs instructions de filtrage à l'aide de l'opérateur AND.	countryCode='CA' AND modifyDate>'2022-01-01'
OU	Joindre deux ou plusieurs instructions de filtrage à l'aide de l'opérateur OR.	countryCode='US' OR countryCode='CA'