Table des matières

Search

  1. Préface
  2. Introduction aux services d'entité commerciale
  3. Appels de services d'entité commerciale Enterprise Java Bean
  4. Appels de services d'entité commerciale Representational State Transfer
  5. Appels de services d'entité commerciale du protocole SOAP (Simple Object Access Protocol)
  6. Services d'enregistrements de références croisées et de calculs de MVV
  7. Prise en charge du service de liaison d'entreprise
  8. Appels externes pour le nettoyage, l'analyse et la transformation de données
  9. Utilisation d'API REST pour ajouter des enregistrements
  10. Utilisation d'API REST pour le chargement de fichiers

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

Utilisez le paramètre
fuzzyFilter
pour spécifier les valeurs de champ pour lesquels effectuer une requête. Utilisez le paramètre
fuzzyFilter
avec le paramètre
action
.
Le tableau suivant décrit les paramètres de la requête que vous pouvez utiliser dans l'URL :
Paramètre
Description
action
Requis. Renvoie les enregistrements correspondants de l'entité d'entreprise spécifiée. Définissez le paramètre sur
match
et utilisez-le avec le paramètre
fuzzyFilter
.
Par exemple, utilisez la requête suivante pour rechercher une personne contenant le prénom STEVE :
Person?action=match&fuzzyFilter=STEVE
fuzzyFilter
Requis. Spécifie une liste de paires nom de champ et valeur de champ séparée par des virgules à utiliser pour rechercher les enregistrements d'un type d'entité d'entreprise spécifique.
Par exemple, utilisez la requête suivante pour rechercher des enregistrements contenant le prénom STEVE, qui possède une adresse à Toronto :
Person?action=match&fuzzyFilter=firstName=STEVE,Address.Address.City=TORONTO
matchRuleSet
Spécifie un ensemble de règles de correspondance selon lequel identifier les enregistrements correspondants.
Si vous ne possédez aucun ensemble de règles de correspondance spécifique, spécifiez NONE. Les règles de correspondance automatique et manuelle sont utilisées.
filter
Spécifie les valeurs de champ à utiliser pour filtrer les résultats d'une recherche approximative.
Par exemple, utilisez la requête suivante pour rechercher des enregistrements contenant le prénom STEVE, qui habite à Toronto :
Person?action=match&fuzzyFilter=firstName='STEVE',lastName="SMITH'&filter=city=Toronto
depth
Spécifie le nombre de niveaux d'enregistrements enfants à renvoyer. Par exemple, vous pouvez spécifier les niveaux suivants :
  • 1. Renvoie l'enregistrement racine.
  • 2. Renvoie l'enregistrement racine et ses enregistrements enfants directs.
  • 3. Renvoie l'enregistrement racine, les enregistrements enfants directs et les enregistrements petits-enfants.
Par exemple, utilisez la requête suivante pour rechercher des enregistrements contenant le prénom STEVE et renvoyez des informations sur l'enregistrement racine et ses enregistrements enfants directs :
Person?action=match&fuzzyFilter=firstName='STEVE'&filter=city=Toronto
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, utilisez la requête suivante pour rechercher des enregistrements contenant le prénom STEVE et renvoyez une réponse dans laquelle aucun lien parent-enfant n'est visible :
Person?action=match&fuzzyFilter=firstName='STEVE'&suppressLinks=true
readSystemFields
Indique si les champs système doivent être renvoyés dans le résultat. La valeur par défaut est False.
fields
Spécifie les champs à afficher dans les résultats de la requête.
outputView
Spécifie la vue Entité d'entreprise à utiliser pour afficher les résultats de la requête. Lorsque vous configurez la vue Entité d'entreprise pour les résultats de la requête, incluez les champs à afficher dans les résultats de la requête.
Vous pouvez utiliser les opérateurs suivants dans le paramètre filter :
AND
Recherche les enregistrements avec toutes les valeurs de champ répertoriées dans le paramètre filter.
Par exemple, utilisez la requête suivante pour rechercher des enregistrements contenant le prénom STEVE et le nom SMITH :
Person?action=match&fuzzyFilter=firstName='STEVE',lastName='SMITH'&filter=city=Toronto AND gender=Male
IN
Recherche les enregistrements avec l'une des valeurs répertoriées dans le paramètre filter.
Par exemple, utilisez la requête suivante pour rechercher des enregistrements contenant le prénom STEVE ou le nom JOHN, qui habite à Toronto ou à Ottawa :
Person?action=match&fuzzyFilter=firstName='STEVE',lastName='SMITH'&filter=city in [Toronto,Ottawa]
RANGE
Recherche les enregistrements dans une plage spécifiée. Vous pouvez spécifier une plage pour les champs des types de données numeric et date.
Utilisez le format suivant pour le type de données entières :
<business entity field name>=[fromValue,toValue]
La plage est générée entre fromValue et toValue. Vérifiez que fromValue est inférieure à toValue.
Par exemple, utilisez la requête suivante pour rechercher des enregistrements dans la tranche d'âge 35 à 45 :
Person?action=match&fuzzyFilter=firstName='STEVE',lastName='SMITH'&filter=age=[35,45]
Utilisez le format suivant pour le type de données date :
<business entity field name>=[fromDate,toDate]
La plage se situe entre fromDate et toDate.
Par exemple, utilisez la requête suivante pour rechercher des enregistrements contenant la date de naissance entre le 12 juin 2000 et le 12 juin 2015 :
Person?action=match&fuzzyFilter=firstName='STEVE',lastName='SMITH'&filter=birthDate=[2000-06-12T12:30:00Z,2015-06-12T12:30:00Z]