Écrit par Don Brinn, développeur de test senior 2
Cet article présente l’utilisation des API Data Hub pour récupérer les ensembles de données Brightspace (BDS) et donne un exemple pratique à l’aide du processus.
Quelles informations puis-je actuellement obtenir de Data Hub ?
Actuellement, les clients peuvent accéder à plus de 130 ensembles de données Brightspace, et ce nombre ne cesse de croître. Les extraits d'ensembles de données Brightspace sont disponibles au format .CSV. Chaque ensemble de données Brightspace est proposé à la fois dans une version complète et dans une version différentielle (chaque fichier d’extrait différentiel inclut les mises à jour et les modifications depuis le fichier différentiel précédent). Un historique des fichiers différentiels précédents est récupérable via Data Hub et l’API, avec des fichiers d’extraction différentielle des 14 derniers jours disponibles via l’API. De plus, les ensembles de données avancés sont également présents dans le Data Hub, mais ils ne font pas partie du champ d’application de cet article.
Comment puis-je accéder au Data Hub ?
Data Hub est accessible dans Brightspace. Pour plus de commodité, une liaison Data Hub peut être ajoutée à votre barre de navigation. Vous pouvez également accéder à /d2l/datahub/dataexport/list dans votre navigateur.
Data Hub est également accessible via l’API. Les sections suivantes vous guideront tout au long de l’accès à Data Hub via l’API.
Quel est le flux attendu lors de l’utilisation de l’API de Data Hub ?
Remarque : l’autorisation n’est pas traitée dans cette section. Consultez la procédure pas à pas du code ci-dessous ou le Jeton d’actualisation article de blog pour plus d’informations.
Les itinéraires ci-dessous sont documentés dans notre Référence de l’API la documentation.
Voir tous les ensembles de données Brightspace
Tout d’abord, décidez de l’ensemble de données Brightspace que vous souhaitez récupérer. Il existe un itinéraire API pour voir les ensembles de données Brightspace disponibles : /d2l/api/lp/1.43/datasets/bds.
Pour chaque ensemble de données Brightspace, cela fournira l’ID de schéma et un lien pour afficher les fichiers d’extrait disponibles au téléchargement. Pour les versions complètes et différentielles de chaque ensemble de données, il inclura leur nom et leur description, l’ID du plugin et un lien pour afficher les fichiers d’extrait disponibles au téléchargement de ce type (complet ou différentiel).
Exemple de sortie :
{
« Objets » : [
{
« SchemaId » : « 4320d948-b06a-4fa2-b4ad-723ed9b002aa »,
« Complet » : {
« PluginId » : « 553ee539-6ecc-4096-b845-acb1e8efd9eb »,
« Nom » : « Objets de publication de flux d’activité »,
« Description » : « L’ensemble de données Activity Feed Post Objects renvoie des détails sur les publications qui ont été créées dans l’organisation. Cela inclut les messages supprimés.",
« ExtractsLink » : « https://myacademy.desire2learn.com/d2l/api/lp/1.43/datasets/bds/4320d948-b06a-4fa2-b4ad-723ed9b002aa/plugins/553ee539-6ecc-4096-b845-acb1e8efd9eb/extracts »
},
« Différentiel » : {
« PluginId » : « 15679ea1-ef36-4839-a57e-8e70da5a98ac »,
« Nom » : « Activity Feed Post Objects Differential »,
« Description » : « L’ensemble de données différentielles Activity Feed Post Objects renvoie des détails sur les publications qui ont été créées dans l’organisation depuis la génération du dernier différentiel. Cela inclut les messages supprimés.",
« ExtractsLink » : « https://myacademy.desire2learn.com/d2l/api/lp/1.43/datasets/bds/4320d948-b06a-4fa2-b4ad-723ed9b002aa/plugins/15679ea1-ef36-4839-a57e-8e70da5a98ac/extracts »
},
« ExtractsLink » : « https://myacademy.desire2learn.com/d2l/api/lp/1.43/datasets/bds/4320d948-b06a-4fa2-b4ad-723ed9b002aa/extracts »
},
{
« SchemaId » : « b1f01838-2cee-44d5-a731-189a15086bd2 »,
« Complet » : {
« PluginId » : « b639f054-10fc-47af-8fd7-1e7d57b2c79e »,
« Nom » : « Options de réponse aux questions du sondage »,
« Description » : « L’ensemble de données sur les options de réponse aux questions de l’enquête renvoie des détails sur chaque option de réponse disponible pour chaque question de l’enquête. »,
« ExtractsLink » : « https://myacademy.desire2learn.com/d2l/api/lp/1.43/datasets/bds/b1f01838-2cee-44d5-a731-189a15086bd2/plugins/b639f054-10fc-47af-8fd7-1e7d57b2c79e/extracts »
},
« Différentiel » : {
« PluginId » : « 43eb179b-342a-40a1-b029-809141955254 »,
« Nom » : « Différentiel des options de réponse aux questions du sondage »,
« Description » : « L’ensemble de données des options de réponse aux questions de l’enquête renvoie les détails différentiels sur chaque option de réponse disponible pour chaque question de l’enquête depuis que le dernier différentiel a été généré. »,
« ExtractsLink » : « https://myacademy.desire2learn.com/d2l/api/lp/1.43/datasets/bds/b1f01838-2cee-44d5-a731-189a15086bd2/plugins/43eb179b-342a-40a1-b029-809141955254/extracts »
},
« ExtractsLink » : « https://myacademy.desire2learn.com/d2l/api/lp/1.43/datasets/bds/b1f01838-2cee-44d5-a731-189a15086bd2/extracts »
},
... (Notez que cette réponse est beaucoup plus longue mais a été tronquée pour la lisibilité de l’article)
],
« Suivant » : « https://myacademy.desire2learn.com/d2l/api/lp/1.43/datasets/bds?bookmark=MTY4NjgzNDAwMA »
}
Notez que ces résultats sont paginés, vous devez donc suivre le lien dans le champ « Suivant » pour voir plus de la liste des ensembles de données, et continuer jusqu’à ce que « Suivant » soit nul.
Voir les fichiers d’extrait disponibles pour un ensemble de données Brightspace
Les ensembles de données Brightspace, contrairement aux ensembles de données avancés, ne prennent pas de paramètres de filtre, donc vous avez seulement besoin de l’ID de schéma et de l’ID du plugin pour voir les fichiers d’extrait d’ensemble de données disponibles et pour en récupérer un.
De plus, les ensembles de données Brightspace ont déjà été générés, vous n’avez donc pas besoin de vérifier leur état avant de les récupérer pour confirmer qu’ils sont complets.
Pour afficher la liste des fichiers d’extrait d’ensemble de données disponibles à récupérer pour la version complète ou différentielle d’un ensemble de données, utilisez l’itinéraire de l’API /d2l/api/lp/1.43/datasets/bds/(schemaId)/plugins/(pluginId)/extracts.
Remplacez « (schemaId) » et « (pluginId) » par les valeurs d’un ensemble de données de l’itinéraire de l’API qui a répertorié tous les ensembles de données Brightspace, comme indiqué dans la section précédente de cet article. Vous pouvez également obtenir l’itinéraire complet de l’API, y compris tous les paramètres, à l’aide des liens « ExtractsLink » de l’itinéraire de l’API qui a répertorié tous les ensembles de données Brightspace.
Chaque objet répertorié par cette API est un fichier d’extrait disponible pour récupération.
Exemple de sortie :
{
« Objets » : [
{
« SchemaId » : « b1f01838-2cee-44d5-a731-189a15086bd2 »,
« PluginId » : « 43eb179b-342a-40a1-b029-809141955254 »,
« BdsType » : « Différentiel »,
« CreatedDate » : « 2023-06-15T16:26:09.433Z »,
« DownloadLink » : « https://myacademy.desire2learn.com/d2l/api/lp/1.43/datasets/bds/b1f01838-2cee-44d5-a731-189a15086bd2/plugins/43eb179b-342a-40a1-b029-809141955254/extracts/MTY4Njg0NjYwMA »,
« DownloadSize » : 225,
« QueuedForProcessingDate » : « 2023-06-15T16:25:57.000Z »,
« Version » : « 8.7 »
},
{
« SchemaId » : « b1f01838-2cee-44d5-a731-189a15086bd2 »,
« PluginId » : « 43eb179b-342a-40a1-b029-809141955254 »,
« BdsType » : « Différentiel »,
« CreatedDate » : « 2023-06-15T15:26:09.347Z »,
« DownloadLink » : « https://myacademy.desire2learn.com/d2l/api/lp/1.43/datasets/bds/b1f01838-2cee-44d5-a731-189a15086bd2/plugins/43eb179b-342a-40a1-b029-809141955254/extracts/MTY4Njg0NjMAYw »,
« DownloadSize » : 225,
« QueuedForProcessingDate » : « 2023-06-15T15:25:57.000Z »,
« Version » : « 8.7 »
},
... (Notez que cette réponse est beaucoup plus longue mais a été tronquée pour la lisibilité de l’article)
],
« Suivant » : « https://myacademy.desire2learn.com/d2l/api/lp/1.44/datasets/bds/a7d6e843-bf8d-4965-9274-95028f3c4d86/plugins/f1623581-c5d7-4562-93fe-6ad16010c96b/extracts?bookmark=MTYjg0NjMAYw4N »
}
Notez que ces résultats sont paginés, vous devez donc suivre le lien dans le champ « Suivant » pour voir plus de la liste des ensembles de données et répéter ce processus jusqu’à ce que « Suivant » soit nul.
Récupérer un fichier d’extrait d’ensemble de données
Une fois que vous avez choisi un ensemble de données, une version de cet ensemble de données (différentiel ou complet) et l’un des fichiers d’extrait disponibles pour celui-ci, il ne reste qu’une seule étape : la récupération du fichier d’extrait.
L’itinéraire de l’API /d2l/api/lp/1.43/datasets/bds/(schemaId)/plugins/(pluginId)/extracts/(extractId) récupérera le fichier d’extrait que vous avez choisi. Vous devez obtenir l’itinéraire complet de l’API avec toutes les valeurs de paramètres remplies (schemaId, pluginId et extractId) en utilisant le lien « DownloadLink » pour le fichier d’extrait que vous avez choisi dans la réponse de l’API affichée dans la section précédente de cet article.
Besoin d’aide supplémentaire pour travailler avec les données ? Coincé sur l’une des étapes ci-dessus ? Vous manquez l’un des ensembles de compétences nécessaires ? D2L fournit des niveaux flexibles de services d’analytique de l’apprentissage qui peuvent vous aider à chaque étape du processus détaillé dans cet article. Si vous êtes intéressé, veuillez contacter votre représentant D2L.
Cet article a été publié à l’origine le 21 février 2019 et a été mis à jour pour refléter nos processus actuels.