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 et 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.
Base de la requête
La requête commence systématiquement par l'URL de votre base, il faudra donc le nom de votre instance, par exemple {NomInstance}, suivi de /api/v3/axisSections qui mentionne que vous souhaitez récupérer les sections d'axes analytiques.
Cela donne donc https://{NomInstance}.ilucca.net/api/v3/axisSections
Choix des champs à afficher
Choisissez ensuite les champs que vous souhaitez afficher et ajouter les après ...axisSections?fields= en les séparant tous d'une virgule.
Par exemple, si vous souhaitez l'identifiant, le nom, le code et s'il est actif ou non, cela donne : https://{NomInstance}.ilucca.net/api/v3/axisSections?fields=id,name,code,active
Quels champs sont récupérables ?
Cela dépend de votre besoin, mais voici les champs les plus utilisés :
| Nom du champ | Description |
| ID | Corresponds à 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 |
Vous pouvez aussi chercher sur cette image :
(Facultatif) Filtrage sur l'axe
Vous pouvez ensuite filtrer sur l'axe souhaité par exemple.
Pour ce faire, vous devez récupérer l'identifiant de l'axe. Si l'on décide d'afficher les sections de l'axe analytique "Test" ici, il faudra utiliser l'identifiant 8 :
Il faut alors l'ajouter à l'URL après ...?fields=...&axisId=
Pour le cas de cet axe analytique d'identifiant 8, cela donne : https://{NomInstance}.ilucca.net/api/v3/axisSections?fields=id,name,code,active&axisId=8
Générer la requête
Une fois que la requête est finalisée, le plus simple est que vous alliez sur votre navigateur et que vous alliez sur l'URL ainsi créé.
Utiliser bien un navigateur sur lequel vous vous êtes connecté à Lucca récemment.
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 suffira généralement de copier la réponse au format JSON dans l'outil sélectionné pour obtenir un fichier au format Excel.
La partie de la réponse à copier est en surbrillance sur cette image :
Il suffit alors, pour l'exemple du site https://www.convertcsv.com/json-to-csv.htm, de le copier ici :
Dans la partie Result, vous aurez la version Excel ou CSV.
Vous pourrez également exploiter ce fichier pour le réimporter si vous avez besoin de faire des modifications. Dans ce cas, mettez bien l'ID dans les champs et préférez le mettre en première colonne, ou à défaut le code de la section, puis mettez le fichier au format CSV avec un séparateur par ";". Dans l'exemple de ce site, c'est dans l'onglet "options".