Import de profils en masse

Il existe une opération pour permettre l'import en masse de profils via les APIs publiques d'ACTITO : POST/entity/{e}/table{t}/import

Cet appel permet de pousser un fichier ZIP contenant un CSV reprenant les données de profils à charger.

Les paramètres suivants doivent être renseignés :

• Le nom de l'entité sur laquelle se trouve la table de profils

• Le nom de la table de profils dans laquelle vous voulez importer des données

• Le format du fichier CSV. 3 formats de fichier CSV sont supportés :

  • COMMA_SEPARATED_VALUES (séparateur : "," et retour à la ligne)

  • TAB_SEPARATED_VALUES (séparateur : indentation et retour à la ligne)

  • SEMI_COLON_SEPARATED_VALUES (séparateur : "; " et retour à la ligne)

• "charset" : L'encodage du fichier CSV. Il s'agit d'UTF-8 par défaut.

• Le mode d'import. Il y a 3 valeurs possibles :

  • CREATE_ONLY : ne charge les données que si elles ne correspondent à aucune ligne dans la table. En d’autres termes, la valeur de la ligne pour la "headerKeyColumn" indiquée ne doit pas exister en base.

  • UPDATE_ONLY : ne charge les données que si elles correspondent à un profil existant dans la table. Il s'agit uniquement d'une mise à jour de profils existants.

  • CREATE_UPDATE : Crée un profil si aucun ne correspond en base et le met à jour si le profil existe déjà.

• "headerKeyColumn" : Nom de la colonne du fichier CSV à utiliser comme clé unique d’identification de la donnée. Cela doit correspondre à un champ unique de la table dans laquelle les données sont chargées.

Format du fichier

Le fichier sur lequel va se baser l'import doit être un fichier ZIP contenant un seul fichier CSV dans un format UTF-8.

Pour connaître le format du fichier propre à votre table de profil, vous pouvez vous aidez des opérations GET servant à obtenir la structure de votre table.

Réponse à l'appel

Obtenir le statut et le résultat de l'import

Si l'appel est un succès, plusieurs opérations sont à votre disposition pour vérifier le bon déroulement de votre import. Elles sont détaillées sous la catégorie "import-controller".

L'opération GET/entity/{e}/import/{i}/status vous permettra d'obtenir le statut de l'import, c'est à dire si l'import est toujours en cours ou s'il est fini.

Il est pour cela nécessaire de renseigner l'entité sur laquelle a été créé l'import, ainsi que l'identifiant technique de l'import que vous avez obtenu en réponse à l'appel.

Il existe 3 statuts possibles :

• RUNNING : L'import est en cours. Il faut attendre qu’il se termine.

• FINISHED : L'import est terminé, le résultat est prêt (voir ci-dessous)

• INERROR : L'import est tombé en erreur, il ne s’est pas fini proprement. C’est bien le job en entier qui tombe en erreur dans ce cas, pas une partie des données qui n’ont pu être importées. C'est uniquement le résultat de l'import qui vous indiquera si certaines lignes de données n'ont pas pu être importées.

L'opération GET/entity{e)/import{i}/result vous permettra d'obtenir le résultat de l'import, c'est à dire si l'import a bien pu être effectué dans sa totalité ou s'il y a des erreurs.

Les paramètres à renseigner sont également l'entité sur laquelle a été créé l'import, ainsi que l'identifiant technique de l'import que vous avez obtenu en réponse à l'appel.

Le résultat obtenu vous indiquera d'une part :

• L'identifiant technique de l'entité, de l'import et de la table de profils

• Le mode de création

• Le moment de début et de fin de l'exécution de l'import

D'autre part, les erreurs éventuelles seront renseignées grâce aux paramètres suivants :

• "withErrors" : Booléen qui indique si l’exécution de l’import a connu une erreur globale. L’import n’a pas pu être exécuté et aucune donnée n’a été traitée.

• "withErrorFile" : Booléen qui indique la présence d’un fichier d’erreur disponible pour téléchargement. Si le champ « withErrorFile » indique "true", le fichier a été traité mais des lignes n’ont pu être importées pour cause d’erreur de format ou d’intégrité. Toutes les lignes peuvent tomber en erreur sans pour autant que ça déclenche une erreur globale.

• "executionResult": Résultat de l’exécution. Aura des données uniquement si il n'y a pas d'erreur globale

  • "rowsRead" : Nombre de lignes prises en considération à cette étape.

  • "rowsWritten" : Nombre de ligne écrites à cette étape et pour lesquelles l'import a donc été un succès.

  • "rowsInError" : Nombre de ligne non traitées pour cause d’erreur.

• "errors" : Cette information ne sera disponible que s’il y a une erreur globale ayant empêché le traitement du fichier. Y sera renseignée la ligne ou colonne problématique.