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

L'identificateur de l'enregistrement est un paramètre requis. L'API utilise l'identificateur d'enregistrement pour rechercher tous les événements d'historique associés.
Le tableau suivant répertorie les paramètres de la requête :
Paramètre
Description
startDate et
endDate
Facultatif. Plage de dates au cours de laquelle vous souhaitez récupérer les données. Si vous spécifiez une plage de dates, la réponse contient uniquement les événements qui se sont produits au cours de cette plage.
granularity
Facultatif. Niveau de détails des événements d'historique du groupe. Si ce paramètre est spécifié, la réponse regroupe les événements d'historique. Dans le cas contraire, elle ne les regroupe pas.
Utilisez l'une des valeurs suivantes :
  • YEAR
  • QUARTER
  • MONTH
  • WEEK
  • DAY
  • HOUR
  • MINUTE
  • AUTO
recordStates
Facultatif. Enregistrez les états renvoyés dans la liste d'événements d'historique. Fournissez une liste de valeurs séparées par des virgules.
Vous pouvez utiliser les valeurs suivantes :
  • ACTIVE
  • PENDING
  • DELETED
contentMetadata
Facultatif. Métadonnées de la liste d'événements d'historique. Fournissez une liste de valeurs séparées par des virgules.
Vous pouvez utiliser les valeurs suivantes :
  • XREF
  • PENDING_XREF
  • DELETED_XREF
  • HISTORY
  • MATCH
  • BVT
  • TRUST
children
Facultatif. Liste séparée par des virgules des noms de nœuds enfants. Si ce paramètre est spécifié, la réponse contient les noms des nœuds enfants.
ordre
Facultatif.
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.
fields
Facultatif. Liste de champs d'entité d'entreprise séparés par des virgules. Si ce paramètre est spécifié, la réponse ne contient que les champs répertoriés.
filter
Facultatif. Expression de filtre.
depth
Facultatif. Nombre de niveaux enfants à renvoyer.
recordsToReturn
Facultatif. Spécifie le nombre de lignes à renvoyer.
searchToken
Facultatif. Spécifie le jeton de recherche renvoyé avec la demande précédente.
returnTotal
Facultatif. Si ce paramètre est défini sur
True
, il renvoie le nombre d'enregistrements dans le résultat. La valeur par défaut est
False
.
firstRecord
Facultatif. Spécifie la première ligne dans le résultat.
changeType
Facultatif. Spécifie les types de modifications renvoyées dans le résultat. Fournissez une liste de valeurs séparées par des virgules.
Vous pouvez utiliser les valeurs suivantes :
  • BO
  • XREF
  • BVT
  • MERGE
  • MERGE_AS_SOURCE
  • MERGE_AS_TARGET
  • UNMERGE_AS_SOURCE
  • UNMERGE_AS_TARGET