Olivier Bayle
Suite à mes deux articles sur l’API Autodesk AEC Data Model, je vous propose « un petit » tutoriel.
Exemple traité : je vais demander l’ensemble répertoires des comptes sur lesquels je suis actif.
Avant d’aller plus loin, je vous invite à lire les deux articles Village BIM (ici et ici).
1- Structuration des « Hubs » :
Ci-dessous, j’ai reconstruit la structuration de la requête « Hubs » dont je vais me servir pour l’exemple (voir l’ensemble de la structuration ici)
2- Requête sur les comptes utilisés :
Dans l’interface de l’API Autodesk AEC Data Model, créez un nouvel onglet (après vous êtres « loggé »).
La première ligne de code va consister à créer la requête (demande) que je vais intituler « VillageBIM » (bien sûr) !
- Positionnez des « { } » afin de définir la zone de la requête (voir ci-dessous) :
- Entre les « { } », enfoncez simultanément les touches « Maj » et « Espace » et choisir l’instance « Hubs » puis positionnez des « { } » comme représenté ci-dessous :
Résultat :
A ce stade, nous allons utiliser deux commandes :
- « Pagination ». La pagination divise de grands ensembles de données en pages plus petites pour une navigation plus facile et évite la surcharge d’informations.
- « Cursor » l’API du modèle de données AEC prend en charge la récupération des données via la pagination basée sur un « cursor ». Elle utilise un identifiant unique (le curseur) associé à chaque page pour récupérer le prochain ensemble de résultats. Cette approche permet une navigation précise dans de grands ensembles de données, garantissant une récupération des données efficace et réactive. Si la valeur du « cursor » est nulle, cela veut dire que le résultat affiche l’ensemble des données.
Voici les commandes ci-dessous :
Nous allons demander les noms des comptes ainsi que leurs identifiants.
- Conformément à la structuration (chapitre 1), nous allons utiliser les commandes « Results », « Name » et « Id » :
- Voici les commandes ci-dessous :
A ce stade, nous allons lancer la requête en cliquant sur le bouton rouge ou enfoncez simultanément les touches « Ctrl » et « Espace » et voici le résultat : soit 4 comptes et leurs identifiants respectifs
Nota : La valeur de « Cursor » est nulle, ce qui signifie que la liste présentée est complète.
3- Requête sur les projets :
- Conformément à la structuration (chapitre 1), nous allons utiliser les commandes « Projects », et réaliser une pagination:
- Voici les commandes ci-dessous :
- Puis pour chaque compte, je vais demander, le nom des projets avec les commandes « Results » et « Name »
A ce stade, nous allons lancer la requête en cliquant sur le bouton rouge ou enfoncez simultanément les touches « Ctrl » et « Espace » et voici le résultat : pour chaque compte sont listés les répertoires :
Nota : le deuxième « Cursor » indique la valeur Nulle, toute la liste des projets est affichée.
4- Requête sur les répertoires :
- Conformément à la structuration (chapitre 1), nous allons utiliser les commandes « Folders », « Results », « Name », et réaliser une pagination:
- Voici les commandes ci-dessous :
- Lancez la requête et voici le résultat : comme indiqué dans le premier article Village BIM (ici), nous avons atteint la limite de 1000 :
Afin d’obtenir des résultats, nous allons limiter la liste des projets afficher en utilisant la commande « Limit ». Voici le code ci-dessous modifié :
- Lancez la requête et voici le résultat : pour chaque compte sont listés les répertoires :
Voici le code final que vous pouvez recopier.
query VillageBIM {
hubs{
pagination{
cursor
}
results{
name
id
projects (pagination : {limit :3}){
pagination{
cursor
}
results{
name
folders (pagination : {limit :3}){
pagination{
cursor
}
results{
name
project{
name
}
}
}
}
}
}
}
}