Guide des services d'entité d'entreprise

10.4 HotFix 2
- 10.4 HotFix 3
- 10.4
- 10.3 HotFix 1
- 10.3
- 10.2 HotFix 1
- 10.2

Précédent Suivant

Paramètres de la requête

Utilisez les paramètres de requête q ou fq pour indiquer la valeur de chaîne pour la recherche. Les paramètres de requête q et fq s'excluent mutuellement. Utilisez le paramètre fq pour une recherche de champ. Utilisez l'opérateur logique AND pour plusieurs conditions.

Le tableau suivant répertorie les paramètres que vous pouvez utiliser dans l'URL :

Paramètre	Description
q	Spécifie la valeur de chaîne ou le terme de recherche. La requête recherche les occurrences du terme de recherche partout dans l'enregistrement. Utilisé dans une recherche simple. Par exemple, la requête Person?q=STEVE recherche les enregistrements contenant le terme STEVE. Pour rechercher simultanément deux termes ou plus, placez-les entre guillemets doubles. Utilisez le caractère + avant chaque terme si vous voulez que les résultats de la recherche contiennent le terme. Si la valeur de champ contient un espace, placez-la entre guillemets simples. Utilisez la requête suivante pour rechercher une correspondance exacte avec WILLIAM JOHN LAWSON : Person?q="WILLIAM JOHN LAWSON" Utilisez la requête suivante pour rechercher WILLIAM, JOHN ou LAWSON : Person?q=WILLIAM JOHN LAWSON Utilisez la requête suivante pour rechercher WILLIAM, JOHN et LAWSON : Person?q=WILLIAM JOHN LAWSON&queryOperator=AND
fq	Spécifie la valeur de chaîne ou le terme de recherche dans un champ particulier. La requête recherche le terme uniquement dans cette partie de l'enregistrement. Utilisé dans une recherche ciblée basée sur des champs indexés. Par exemple, la requête Person?fq=displayname=STEVE recherche les enregistrements contenant le nom d'affichage STEVE.
facets	Spécifie les champs qui doivent être traités comme facettes ou les catégories utilisées pour grouper les résultats de la recherche. Spécifiez uniquement les champs de recherche. Utilisé avec les paramètres q et fq. La syntaxe est la suivante : &facets=FieldName1,FieldName2,FieldNameN . Par exemple, la requête Person?q=STEVE&facets=department recherche les personnes dont le nom d'affichage est STEVE et groupe les résultats de la recherche par service. La recherche affiche les enregistrements des personnes dont le nom d'affichage est STEVE et ces enregistrements sont groupés par service.
filters	Spécifie les champs utilisés pour affiner les résultats de la recherche. Spécifiez uniquement les champs filtrables. Utilisé avec les paramètres q et fq. Par exemple, la requête Person?fq=STEVE&filters=birthdate='1980-11-27T08:00:00Z' recherche les personnes dont le nom d'affichage est STEVE et filtres les résultats de la recherche par date de naissance. La recherche affiche les enregistrements des personnes dont le nom d'affichage est STEVE et dont la date de naissance est le 27 novembre 1980. Spécifiez une date entre guillemets simples.
depth	Spécifie le nombre de niveaux enfants à renvoyer. Indiquez 2 pour renvoyer le nœud racine et ses enfants directs et 3 pour renvoyer le nœud racine, ses enfants directs et ses petits-enfants. Indiquez 1 pour renvoyer le nœud racine uniquement. Par défaut, aucun niveau n'est spécifié. Si aucun niveau n'est spécifié, les résultats de recherche renvoient le nœud racine et les enfants dans lesquels une correspondance du terme de recherche est trouvée. Par exemple, la requête Person?q=STEVE&depth=2 recherche les enregistrements contenant le terme STEVE et renvoie des informations sur l'enregistrement racine et ses enfants directs.
queryOperator	Indique si la recherche doit trouver l'une des chaînes contenue dans le terme de recherche ou toutes les chaînes contenues dans le terme de recherche. Ce paramètre prend l'une des valeurs suivantes : OR . Recherche n'importe quelle chaîne indiquée dans le paramètre f ou fq . AND . Recherche toutes les chaînes indiquées dans le paramètre f ou fq . Si vous ne spécifiez pas ce paramètre, la valeur par défaut est OR . Par exemple, la requête Person?q=WILLIAM JOHN LAWSON&queryOperator=AND recherche les enregistrements contenant WILLIAM, JOHN et LAWSON.
suppressLinks	Indique si les liens parent-enfant sont visibles dans la réponse de l'API. Définissez le paramètre sur True pour supprimer tous les liens parent-enfant dans la réponse. La valeur par défaut est False. Par exemple, la requête Person?q=STEVE&suppressLinks=true recherche les enregistrements contenant le terme STEVE et renvoie la réponse dans laquelle aucun lien parent-enfant n'est visible.
readSystemFields	Indique si les champs système doivent être renvoyés dans le résultat. La valeur par défaut est False.
ordre	Liste de noms de champs séparés par des virgules et contenant un préfixe facultatif + ou - . Le préfixe + indique de classer les résultats par ordre croissant et le préfixe - par ordre décroissant. La valeur par défaut est + . Si vous voulez faire appel à un champ enfant pour trier les résultats, utiliser le nom complet du champ. Par exemple, BillAddresses.Address.cityName . Lorsque vous spécifiez plusieurs paramètres, l'ensemble de résultats est trié selon le premier paramètre de la liste, puis selon le suivant. Par exemple, la requête Person?order=displayName,-BillAddresses.Address.cityName trie les résultats par nom d'affichage par ordre croissant, puis par nom de ville par ordre décroissant.
maxRecordsToSort	Nombre maximal de résultats de recherche à trier. La valeur par défaut est 1000.

Spécifiez une plage avec le paramètre
filtres
:

Vous pouvez utiliser le paramètre filtres pour affiner les résultats de la recherche dans une plage spécifiée. Vous pouvez spécifier la plage pour les champs filtrables des types de données numériques et de date.

Utilisez le format suivant pour le type de données entières :

fieldName1=[fromValue,toValue]

La plage est générée entre fromValue et toValue. Vérifiez que fromValue est inférieure à toValue. Par exemple, la requête

filters=age=[35,45]

affine les résultats de la recherche et recherche les enregistrements dans le groupe d'âge 35-45.

Utilisez le format suivant pour le type de données de date :

fieldName1=[fromDate,toDate]

La plage est générée entre fromDate et toDate. Par exemple, la requête

filters=birthdate=[2000-06-12T12:30:00Z,2015-06-12T12:30:00Z]

spécifie la date de naissance entre le 12 juin 2000 et le 12 juin 2015.

Lorsque vous spécifiez un filtre de correspondance exacte de date, placez-le entre guillemets simples. Lorsque vous spécifiez une plage de dates, n'utilisez pas de guillemets.

Rechercher un enregistrement

Date et heure au format UTC

Télécharger le guide

Envoyer les commentaires

Communities

Knowledge Base

Portail du succès

Rename Saved Search

Table des matières

Guide des services d'entité d'entreprise

Guide des services d'entité d'entreprise

Paramètres de la requête

Paramètres de la requête