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
  11. Utilisation des API REST pour gérer les rapports

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

Vous pouvez ajouter les paramètres de la requête à l'URL de la demande pour filtrer les détails de l'enregistrement.
Le tableau suivant répertorie les paramètres de la requête :
Paramètre
Description
depth
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. La valeur par défaut est 1.
effectiveDate
Date pour laquelle vous souhaitez récupérer les données.
readSystemFields
Indique si les champs système doivent être renvoyés dans le résultat. La valeur par défaut est False.
recordStates
Etat de l'enregistrement. Fournissez une liste d'états séparés par des virgules. Les états d'enregistrements pris en charge sont ACTIVE, PENDING et DELETED. La valeur par défaut est ACTIVE.
contentMetadata
Métadonnées de l'enregistrement. Fournissez une liste de valeurs séparées par des virgules. Par exemple, XREF, PENDING_XREF, DELETED_XREF, HISTORY, XREF_HISTORY et MATCH.
Lorsque vous sélectionnez MATCH, la réponse contient une liste d'enregistrements correspondants qui sont récupérés de la table _MTCH.
historyDate
Date à laquelle vous souhaitez récupérer les données d'historique. La réponse contient les données d'enregistrement pour la date spécifiée récupérée de la table _HIST.
Vous pouvez utiliser historyDate combiné au paramètre contentMetadata pour récupérer les métadonnées d'historique. Définissez la valeur de contentMetadata sur XREF, BVT ou TRUST.
  • XREF. La réponse contient des données de références croisées d'historique de la table _HXRF.
  • BVT. La réponse contient la meilleure version de la vérité de l'historique de la table _HCTL.
  • TRUST. La réponse contient les paramètres d'approbation d'historique des tables _HCTL et _HVXR.
children
Liste séparée par des virgules de noms ou de chemins de nœud enfants.
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/1242?depth=10&suppressLinks=true
permet d'afficher les détails d'enregistrements jusqu'à 10 niveaux enfant, sans lien parent-enfant visible dans la réponse.
order
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
+
. Lorsque vous spécifiez plusieurs paramètres, l'ensemble de résultats est trié selon le premier paramètre de la liste, puis par le suivant.
Par exemple, la requête
Person/1242/Names?order=-name
affiche le résultat contenant les noms dans l'ordre décroissant.
La requête
Person/1242/BillAddresses?order=rowidObject,-effStartDate
affiche les adresses de facturation contenant le rowid par ordre croissant, puis la date de début effective par ordre décroissant.
L'exemple suivant montre comment filtrer les détails d'un enregistrement :
GET http://localhost:8080/cmx/cs/localhost-orcl-DS_UI1/Person/123/Phone/SFA:456/PhoneUse?recordsToReturn=100&recordStates=ACTIVE,PENDING&contentMetadata=XREF