Escrito por Don Brinn, desarrollador sénior de pruebas 2
En este artículo, se presenta el uso de las API de Data Hub para recuperar conjuntos de datos de Brightspace (BDS) y se ofrece un ejemplo práctico del proceso.
¿Qué información puedo obtener actualmente de Data Hub?
Actualmente, los clientes pueden acceder a más de 130 conjuntos de datos de Brightspace y esto sigue creciendo. Los extractos del conjunto de datos de Brightspace están disponibles como archivos . Archivos CSV. Cada conjunto de datos de Brightspace está disponible tanto en una versión completa como en una versión diferencial (cada archivo de extracción diferencial incluye actualizaciones y cambios desde el archivo diferencial anterior). Se puede recuperar un historial de archivos diferenciales anteriores a través de Data Hub y la API, con archivos de extracción diferencial de los últimos 14 días disponibles a través de la API. Además, los conjuntos de datos avanzados también se encuentran en el centro de datos, pero están fuera del alcance de este artículo.
¿Cómo accedo a Data Hub?
Se puede acceder a Data Hub en Brightspace. Para mayor comodidad, se puede agregar un enlace de Data Hub a la barra de navegación. Como alternativa, también puede navegar hasta /d2l/datahub/dataexport/list en su navegador.
También se puede acceder a Data Hub a través de la API. En las siguientes secciones, se explica cómo acceder a Data Hub a través de la API.
¿Cuál es el flujo esperado al usar la API de Data Hub?
Nota: La autorización no se trata en esta sección. Consulte el tutorial de código a continuación o el Token de actualización para obtener más información.
Las rutas a continuación están documentadas dentro de nuestro Referencia de la API documentación.
Ver todos los conjuntos de datos de Brightspace
Primero, decida qué conjunto de datos de Brightspace le gustaría recuperar. Hay una ruta de API para ver los conjuntos de datos de Brightspace disponibles: /d2l/api/lp/1.43/conjuntos de datos/bds.
Para cada conjunto de datos de Brightspace, se proporcionará el ID de esquema y un enlace para ver los archivos de extracción disponibles para descargar. Para las versiones completas y diferenciales de cada conjunto de datos, incluirá su nombre y descripción, el ID del complemento y un enlace para ver los archivos de extracción disponibles para descargar de ese tipo (completos o diferenciales).
Ejemplo de salida:
{
"Objetos": [
{
"SchemaId": "4320d948-b06a-4fa2-b4ad-723ed9b002aa",
"Lleno": {
"PluginId": "553ee539-6ecc-4096-b845-acb1e8efd9eb",
"name": "Objetos de publicación de feed de actividad",
"Descripción": "El conjunto de datos de objetos de publicación de la fuente de actividad devuelve detalles de las publicaciones que se han creado en la organización. Esto incluye las publicaciones eliminadas.",
"ExtractsLink": "https://myacademy.desire2learn.com/d2l/api/lp/1.43/datasets/bds/4320d948-b06a-4fa2-b4ad-723ed9b002aa/plugins/553ee539-6ecc-4096-b845-acb1e8efd9eb/extracts"
},
"Diferencial": {
"PluginId": "15679ea1-ef36-4839-a57e-8e70da5a98ac",
"nombre": "Diferencial de objetos de publicación de feed de actividad",
"Descripción": "El conjunto de datos diferenciales Activity Feed Post Objects devuelve detalles de las publicaciones que se han creado en la organización desde que se generó el último diferencial. Esto incluye las publicaciones eliminadas.",
"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",
"Lleno": {
"PluginId": "b639f054-10fc-47af-8fd7-1e7d57b2c79e",
"Nombre": "Opciones de respuesta a la pregunta de la encuesta",
"Descripción": "El conjunto de datos de opciones de respuesta a la pregunta de la encuesta devuelve detalles sobre cada opción de respuesta disponible para cada pregunta de la encuesta".
"ExtractsLink": "https://myacademy.desire2learn.com/d2l/api/lp/1.43/datasets/bds/b1f01838-2cee-44d5-a731-189a15086bd2/plugins/b639f054-10fc-47af-8fd7-1e7d57b2c79e/extracts"
},
"Diferencial": {
"PluginId": "43eb179b-342a-40a1-b029-809141955254",
"Nombre": "Diferencial de opciones de respuesta a la pregunta de la encuesta",
"Descripción": "El diferencial del conjunto de datos de opciones de respuesta a la pregunta de la encuesta devuelve detalles sobre cada opción de respuesta disponible para cada pregunta de la encuesta desde que se generó la última diferencial.",
"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"
},
... (Tenga en cuenta que esta respuesta es significativamente más larga, pero se ha truncado para facilitar la lectura del artículo)
],
"Siguiente": "https://myacademy.desire2learn.com/d2l/api/lp/1.43/datasets/bds?bookmark=MTY4NjgzNDAwMA"
}
Tenga en cuenta que estos resultados están paginados, por lo que debe seguir el enlace en el campo "Siguiente" para ver más de la lista de conjuntos de datos y continuar hasta que "Siguiente" sea nulo.
Consulte Extraer archivos disponibles para un conjunto de datos de Brightspace
Los conjuntos de datos de Brightspace, a diferencia de los conjuntos de datos avanzados, no toman parámetros de filtro, por lo que solo necesita el ID de esquema y el ID del complemento para ver los archivos de extracción del conjunto de datos disponibles y recuperar uno de ellos.
Además, los conjuntos de datos de Brightspace ya se han generado, por lo que no es necesario verificar su estado antes de recuperarlos para confirmar que están completos.
Para ver la lista de archivos de extracción de conjuntos de datos disponibles para recuperar la versión completa o diferencial de un conjunto de datos, utilice la ruta de API /d2l/api/lp/1.43/datasets/bds/(schemaId)/plugins/(pluginId)/extracts.
Reemplace "(schemaId)" y "(pluginId)" por los valores de un conjunto de datos de la ruta de la API que enumeró todos los conjuntos de datos de Brightspace, como se muestra en la sección anterior de este artículo. También puede obtener la ruta completa de la API, incluidos todos los parámetros, mediante los enlaces "ExtractsLink" de la ruta de la API que enumeró todos los conjuntos de datos de Brightspace.
Cada objeto enumerado por esta API es un archivo de extracción disponible para recuperar.
Salida de ejemplo:
{
"Objetos": [
{
"SchemaId": "b1f01838-2cee-44d5-a731-189a15086bd2",
"PluginId": "43eb179b-342a-40a1-b029-809141955254",
"BdsType": "Diferencial",
"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",
"Versión": "8.7"
},
{
"SchemaId": "b1f01838-2cee-44d5-a731-189a15086bd2",
"PluginId": "43eb179b-342a-40a1-b029-809141955254",
"BdsType": "Diferencial",
"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",
"Versión": "8.7"
},
... (Tenga en cuenta que esta respuesta es significativamente más larga, pero se ha truncado para facilitar la lectura del artículo)
],
"Siguiente": "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"
}
Tenga en cuenta que estos resultados están paginados, por lo que debe seguir el enlace en el campo "Siguiente" para ver más de la lista de conjuntos de datos y repetir ese proceso hasta que "Siguiente" sea nulo.
Recuperar un archivo de extracción de un conjunto de datos
Una vez que haya elegido un conjunto de datos, una versión de ese conjunto de datos (diferencial o completo) y uno de los archivos de extracción disponibles para él, solo queda un paso: recuperar el archivo de extracción.
La ruta de la API /d2l/api/lp/1.43/datasets/bds/(schemaId)/plugins/(pluginId)/extracts/(extractId) recuperará el archivo de extracción elegido. Debe obtener la ruta completa de la API con todos los valores de parámetro rellenados (schemaId, pluginId y extractId) mediante el enlace "DownloadLink" para el archivo de extracción elegido en la respuesta de la API que se muestra en la sección anterior de este artículo.
¿Necesita más ayuda para trabajar con datos? ¿Atascado en alguno de los pasos anteriores? ¿Le falta uno de los conjuntos de habilidades necesarios? D2L proporciona niveles flexibles de servicios de Learning Analytics que pueden ayudar con cualquiera o todos los pasos del proceso detallado en esta publicación. Si está interesado, póngase en contacto con su representante de D2L.
Este artículo se publicó originalmente el 21 de febrero de 2019 y se ha actualizado para reflejar nuestros procesos actuales.