Escrito por Don Brinn, Desenvolvedor de Teste Sênior 2
Este artigo apresenta o uso das APIs do Data Hub para recuperar conjuntos de dados do Brightspace (BDS) e fornece um exemplo prático de como usar o processo.
Quais informações posso obter atualmente do Data Hub?
Atualmente, os clientes podem acessar mais de 130 conjuntos de dados do Brightspace e isso continua crescendo. As extrações do Conjunto de dados do Brightspace estão disponíveis como . CSV. Cada conjunto de dados do Brightspace está disponível em uma versão completa e em uma versão diferencial (cada arquivo de extração diferencial inclui atualizações e alterações desde o arquivo diferencial anterior). Um histórico de arquivos diferenciais anteriores pode ser recuperado por meio do Data Hub e da API, com arquivos de extração diferencial dos últimos 14 dias disponíveis por meio da API. Além disso, os conjuntos de dados avançados também estão localizados no Data Hub, mas estão fora do escopo deste artigo.
Como faço para acessar o Data Hub?
O Data Hub pode ser acessado no Brightspace. Por conveniência, um link do Data Hub pode ser adicionado à sua barra de navegação. Como alternativa, você também pode navegar até /d2l/datahub/dataexport/list no seu navegador.
O Data Hub também pode ser acessado via API. As seções a seguir orientarão você no acesso ao Data Hub por meio da API.
Qual é o fluxo esperado ao usar a API do Data Hub?
Nota: A autorização não é abordada nesta seção. Veja o passo a passo do código abaixo ou o Token de atualização para obter mais informações.
As rotas abaixo estão documentadas em nosso Referência de API documentação.
Veja todos os conjuntos de dados do Brightspace
Primeiro, decida qual conjunto de dados do Brightspace você gostaria de recuperar. Há uma rota de API para ver os conjuntos de dados do Brightspace disponíveis: /d2l/api/lp/1.43/datasets/bds.
Para cada conjunto de dados do Brightspace, isso fornecerá a ID do esquema e um link para exibir os arquivos de extração disponíveis para download. Para as versões completa e diferencial de cada conjunto de dados, ele incluirá seu nome e descrição, o ID do plug-in e um link para visualizar os arquivos de extração disponíveis para download desse tipo (completo ou diferencial).
Exemplo de saída:
{
"Objetos": [
{
"SchemaId": "4320d948-b06a-4fa2-b4ad-723ed9b002aa",
"Completo": {
"PluginId": "553ee539-6ecc-4096-b845-acb1e8efd9eb",
"Name": "Objetos de postagem do feed de atividades",
"Description": "O conjunto de dados Objetos de postagem do feed de atividades retorna detalhes das postagens que foram criadas na organização. Isso inclui postagens excluídas.",
"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",
"Name": "Diferencial de Objetos de Postagem do Feed de Atividades",
"Description": "O conjunto de dados diferenciais Activity Feed Post Objects retorna detalhes das postagens que foram criadas na organização desde que o último diferencial foi gerado. Isso inclui postagens excluídas.",
"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",
"Completo": {
"PluginId": "b639f054-10fc-47af-8fd7-1e7d57b2c79e",
"Name": "Opções de resposta à pergunta da pesquisa",
"Description": "O conjunto de dados das opções de resposta da pergunta da pesquisa retorna detalhes sobre cada opção de resposta disponível para cada pergunta da pesquisa.",
"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",
"Nome": "Diferencial de opções de resposta à pergunta da pesquisa",
"Description": "O diferencial do conjunto de dados do conjunto de dados de opções de resposta da pergunta da pesquisa retorna detalhes sobre cada opção de resposta disponível para cada pergunta da pesquisa desde que o último diferencial foi gerado.",
"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"
},
... (Observe que esta resposta é significativamente mais longa, mas foi truncada para facilitar a leitura do artigo)
],
"Próximo": "https://myacademy.desire2learn.com/d2l/api/lp/1.43/datasets/bds?bookmark=MTY4NjgzNDAwMA"
}
Observe que esses resultados são paginados, portanto, você deve seguir o link no campo "Avançar" para ver mais da lista de conjuntos de dados e continuar até que "Avançar" seja nulo.
Consulte Extrair arquivos disponíveis para um conjunto de dados do Brightspace
Os conjuntos de dados do Brightspace, ao contrário dos conjuntos de dados avançados, não usam parâmetros de filtro, portanto, você só precisa da ID do esquema e da ID do plug-in para ver os arquivos de extração do conjunto de dados disponíveis e recuperar um deles.
Além disso, os conjuntos de dados do Brightspace já foram gerados, portanto, você não precisa verificar seu status antes de recuperá-los para confirmar se estão completos.
Para visualizar a lista de arquivos de extração do conjunto de dados disponíveis para recuperação para a versão completa ou diferencial de um conjunto de dados, use a rota da API /d2l/api/lp/1.43/datasets/bds/(schemaId)/plugins/(pluginId)/extrações.
Substitua "(schemaId)" e "(pluginId)" pelos valores de um conjunto de dados da rota da API que listou todos os conjuntos de dados do Brightspace, conforme mostrado na seção anterior deste artigo. Você também pode obter a rota completa da API, incluindo todos os parâmetros, usando os links "ExtractsLink" da rota da API que listou todos os conjuntos de dados do Brightspace.
Cada objeto listado por essa API é um arquivo de extração disponível para recuperação.
Exemplo de saída:
{
"Objetos": [
{
"SchemaId": "b1f01838-2cee-44d5-a731-189a15086bd2",
"PluginId": "43eb179b-342a-40a1-b029-809141955254",
"BdsType": "Diferencial",
"Data de criação": "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",
"Tamanho do Download": 225,
"QueuedForProcessingDate": "2023-06-15T16:25:57.000Z",
"Versão": "8.7"
},
{
"SchemaId": "b1f01838-2cee-44d5-a731-189a15086bd2",
"PluginId": "43eb179b-342a-40a1-b029-809141955254",
"BdsType": "Diferencial",
"Data de criação": "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",
"Tamanho do Download": 225,
"QueuedForProcessingDate": "2023-06-15T15:25:57.000Z",
"Versão": "8.7"
},
... (Observe que esta resposta é significativamente mais longa, mas foi truncada para facilitar a leitura do artigo)
],
"Próximo": "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"
}
Observe que esses resultados são paginados, portanto, você deve seguir o link no campo "Avançar" para ver mais da lista de conjuntos de dados e repetir esse processo até que "Avançar" seja nulo.
Recuperar um arquivo de extração do conjunto de dados
Depois de escolher um conjunto de dados, uma versão desse conjunto de dados (diferencial ou completo) e um dos arquivos de extração disponíveis para ele, resta apenas uma etapa – recuperar o arquivo de extração.
A rota da API /d2l/api/lp/1.43/datasets/bds/(schemaId)/plugins/(pluginId)/extracts/(extractId) recuperará o arquivo de extração escolhido. Você deve obter a rota completa da API com todos os valores de parâmetro preenchidos (schemaId, pluginId e extractId) usando o link "DownloadLink" para o arquivo de extração escolhido na resposta da API mostrada na seção anterior deste artigo.
Precisa de mais ajuda para trabalhar com dados? Preso em alguma das etapas acima? Faltando um dos conjuntos de habilidades necessários? A D2L fornece níveis flexíveis de serviços de análise de aprendizagem que podem ajudar em qualquer uma ou em todas as etapas do processo detalhadas nesta postagem. Se você estiver interessado, entre em contato com seu representante da D2L.
Este artigo foi publicado originalmente em 21 de fevereiro de 2019 e foi atualizado para refletir nossos processos atuais.