Types d'événements disponibles pour filtrer les tiers, dossiers et documents via le paramètre eventName.
Filtrage par événements
L'API permet de filtrer les ressources (tiers, dossiers, documents) en fonction des événements survenus. Utilisez le paramètre eventName dans vos requêtes pour filtrer par type d'événement.
Filtrage par Événements
La plateforme Aprovall maintient un journal d'audit complet de tous les changements et actions significatifs sur les ressources (tiers, dossiers et documents). Chaque modification, changement de statut, ajout de commentaire ou mise à jour de données génère un événement qui est enregistré de manière permanente dans le système.
La fonctionnalité de filtrage par événements vous permet de rechercher des ressources en fonction de leur historique d'activité. Par exemple, vous pouvez trouver tous les tiers qui ont eu une mise à jour d'indicateur dans une plage de dates, ou tous les dossiers qui sont passés du statut INVALIDE le mois dernier.
Fonctionnement
Le filtrage par événements nécessite trois paramètres qui doivent être fournis ensemble :
eventNames - Un ou plusieurs codes de type d'événement (ex : THIRD_PARTY_ADDED, DOSSIER_STATUS_UPDATED_VALID)
eventOccurrenceStartDate - Le début de la plage temporelle (format ISO-8601 : yyyy-MM-dd'T'HH:mm:ss)
eventOccurrenceEndDate - La fin de la plage temporelle (format ISO-8601 : yyyy-MM-dd'T'HH:mm:ss)
Lorsque vous fournissez ces paramètres, l'API retourne les ressources qui ont au moins un événement correspondant dans la plage de dates spécifiée. Plusieurs noms d'événements sont combinés avec une logique OU, ce qui signifie que la ressource sera retournée si elle possède N'IMPORTE QUEL événement spécifié pendant la période.
Cas d'Usage par Ressource
Tiers (Third Parties)
Surveillance des changements d'indicateurs : Trouver tous les tiers qui ont eu une mise à jour d'indicateur dans les 30 derniers jours :
GET /api/v1/account/123/thirdparties/search?eventNames=THIRD_PARTY_INDICATOR_UPDATED&eventOccurrenceStartDate=2024-01-01T00:00:00&eventOccurrenceEndDate=2024-01-31T23:59:59
Suivi des ajouts et archivages : Trouver tous les tiers ajoutés ou archivés ce mois :
GET /api/v1/account/123/thirdparties/search?eventNames=THIRD_PARTY_ADDED,THIRD_PARTY_ARCHIVED&eventOccurrenceStartDate=2024-01-01T00:00:00&eventOccurrenceEndDate=2024-01-31T23:59:59
Synchronisation des modifications : Récupérer tous les tiers modifiés depuis votre dernière synchronisation :
GET /api/v1/account/123/thirdparties/search?eventNames=THIRD_PARTY_UPDATED,THIRD_PARTY_INFORMATION_UPDATED&eventOccurrenceStartDate=2024-01-15T14:30:00&eventOccurrenceEndDate=2024-01-16T14:30:00
Dossiers
Suivi des transitions de statut : Trouver tous les dossiers qui sont devenus valides ou invalides le mois dernier :
GET /api/v1/account/123/dossiers/search?eventNames=DOSSIER_STATUS_UPDATED_VALID,DOSSIER_STATUS_UPDATED_INVALID&eventOccurrenceStartDate=2023-12-01T00:00:00&eventOccurrenceEndDate=2023-12-31T23:59:59
Surveillance des dossiers nécessitant une action : Trouver tous les dossiers passés en statut "Action requise" cette semaine :
GET /api/v1/account/123/dossiers/search?eventNames=DOSSIER_STATUS_UPDATED_ACTION_REQUIRED&eventOccurrenceStartDate=2024-01-08T00:00:00&eventOccurrenceEndDate=2024-01-14T23:59:59
Suivi des indicateurs de dossiers : Trouver tous les dossiers avec une mise à jour d'indicateur calculé :
GET /api/v1/account/123/dossiers/search?eventNames=DOSSIER_INDICATOR_UPDATED,DOSSIER_CALCULATED_ATTRIBUTE_UPDATED&eventOccurrenceStartDate=2024-01-01T00:00:00&eventOccurrenceEndDate=2024-01-31T23:59:59
Documents
Suivi des validations : Trouver tous les documents dont une réponse a été acceptée au T1 2024 :
GET /api/v1/account/123/documents/search?eventNames=DOCUMENT_ANSWER_ACCEPTED&eventOccurrenceStartDate=2024-01-01T00:00:00&eventOccurrenceEndDate=2024-03-31T23:59:59
Surveillance des documents invalides : Trouver tous les documents passés en statut invalide cette semaine :
GET /api/v1/account/123/documents/search?eventNames=DOCUMENT_ANSWER_STATUS_UPDATE_INVALID&eventOccurrenceStartDate=2024-01-08T00:00:00&eventOccurrenceEndDate=2024-01-14T23:59:59
Suivi des nouvelles réponses : Trouver tous les documents qui ont reçu une nouvelle réponse aujourd'hui :
GET /api/v1/account/123/documents/search?eventNames=DOCUMENT_ANSWER_ADDED,DOCUMENT_ANSWER_UPDATED&eventOccurrenceStartDate=2024-01-15T00:00:00&eventOccurrenceEndDate=2024-01-15T23:59:59
Bonnes Pratiques de Performance
Pour des performances optimales de l'API :
Limitez les plages de dates à des périodes raisonnables (évitez les requêtes sur plusieurs années)
Combinez le filtrage par événements avec d'autres critères pour réduire les ensembles de résultats
Utilisez des types d'événements spécifiques plutôt que des recherches larges
Envisagez d'implémenter une synchronisation incrémentale basée sur les horodatages des événements
Chaque type de ressource (tiers, dossiers, documents) possède son propre ensemble de types d'événements - référez-vous aux tableaux de référence des types d'événements ci-dessous pour la liste complète des événements disponibles pour chaque ressource.
Liste complète des événements (100 types d'événements)
