Avant de commencer
Cette fiche explique comment récupérer la liste des sections analytiques d'une instance Lucca. Elle s'adresse aux administrateurs avancés.
La récupération des données passe par trois étapes :
- Construction de la requête API
- Génération de la requête
- Exploitation de la réponse
Construire la requête API permettant de récupérer les données
L'interface actuelle de gestion des axes analytiques ne vous permet pas de récupérer la liste des sections analytiques. Vous devez pour cela faire une requête API.
Pour construire cette requête, vous pouvez vous appuyer sur la documentation concernée.
Une alternative plus simple consiste à construire l'URL directement depuis l'interface de votre instance Lucca accessible à l'URL de la forme suivante : https://masociete.ilucca.net/apihelp
Une fois sur l'interface, cliquez sur "axissections" dans la colonne de gauche.
Cette interface vous permet de construire la requête en ajoutant les champs que vous souhaitez, en les cochant simplement dans la liste.
Quels champs récupérer ?
Cela dépend de votre besoin mais voici les champs les plus utilisés :
Nom du champ | Description |
ID | Correspond à l'identifiant unique de la section. Est nécessaire si vous souhaitez modifier le code d'une section via un import. |
Name | Nom de la section |
Code | Code de la section. Indispensable en cas d'import |
AxisId | Identifiant de l'axe auquel appartient la section. Indispensable en cas d'import |
Active | Indique si la section est archivée (active = false) ou non |
Owner | Responsable de la section analytique |
ParentAxisSections | Sections de l'axe parent auxquelles est rattachée la section |
Departments | Si restriction d'accès : départements ayant accès à la section |
LegalEntities | Si restriction d'accès : établissements ayant accès à la section |
Users | Si restriction d'accès : utilisateurs ayant accès à la section |
Générer la requête
Une fois que vous avez coché les champs souhaités, vous avec deux options pour générer la requête :
- Depuis l'interface, en cliquant sur GET dans la partie de droite.
- Si la requête prend trop de temps, vous pouvez aussi récupérer la requête /api/v3.... depuis l'interface, et la coller directement dans l'URL de votre navigateur.
Cela vous donnera une URL de cette forme : https://morgan.ilucca-demo.net/api/v3/axissections?fields=id,name,axisid,code,active
Le résultat de la requête s'affichera alors dans votre navigateur :
Exploiter le résultat de la requête
La réponse à cette requête sera au format JSON. Vous pouvez sans difficulté utiliser un outil qui convertira ce format au format Excel (ex: http://www.convertcsv.com/json-to-csv.htm).
Il suffit généralement de copier la réponse au format JSON dans l'outil sélectionné pour obtenir un fichier au format Excel.
Vous pourrez également exploiter ce fichier pour le réimporter si vous avez besoin de faire des modifications. Dans ce cas, préférez l'ID de la section en première colonne, ou à défaut le code de la section.