Skip to main content

Especificações REST Recebidas

Note

Esta documentação foi traduzida utilizando tradução automática assistida por IA. As traduções são fornecidas "no estado em que se encontram", sem qualquer garantia quanto à sua precisão. A versão em inglês deste conteúdo é a fonte oficial e de referência.

O Grades Journey v2 pode fornecer dados do boletim usando APIs REST. Embora essas APIs sejam diferentes das APIs principais do Learn, a autenticação da API do Grades Journey v2 segue o mesmo processo de autenticação OAuth2 da API REST principal do Learn. Isto requer uma configuração de aplicativo API REST no Portal do Desenvolvedor do Blackboard. Consulte a documentação do desenvolvedor no Blackboard para mais informações sobre configuração do aplicativo e autenticação OAuth2.

Criar Esquema de Avaliação

Endpoint de serviço web

https://{{hostname}}/learn/api/v2/cc/gradejourney/gradeSchemasAPI

Exemplo de Corpo JSON

[
   {
       "title": "Pass-Fail-Custom-Schema",
       "symbols": "P=80:F=0",
       "optionalData": "sisSchemaID=PF"
   }
]

Definições de Elementos do Esquema de Graduação

Nome do elemento

Descrição

Obrigatório

Tipo e tamanho máximo

título

Título do Esquema de Avaliação.

sim

String (333 caracteres)

símbolos

Símbolos em uma lista com um limite inferior opcional.

sim

String (2000 caracteres)

optionalData

Pares chave/valor com cada conjunto de pares separados por dois pontos e chave/valores separados por um sinal de igual. Por exemplo: key1=value1:key2=value2

não

String (2000 caracteres)

Exemplo de resposta

[ 
   { 
       "courseId": "", 
       "name": "Pass-Fail-Custom-Schema", 
       "status": "OK", 
       "message": "Grade schema successfully created" 
   }
]

Criar itens graduáveis e colunas de avaliação

Endpoint de serviço web

https://{{hostname}}/learn/api/v2/cc/gradejourney/gradableItemsAPI

Exemplo de Corpo JSON

[
   {
       "courseId": "course1",
       "name": "Final Grade",
       "itemType": "MANUAL_COLUMN",
       "instructions": ""
       "anonymous": false,
       "group": false,
       "contentAreaName": "Assignments",
       "available": true,
       "attempts": 1,
       "tracked": false,
       "startDate":
       "endDate":
       "dueDate": "",
       "points": 100,
       "gradeSchema": "Pass-Fail-Custom-Schema",
       "sequenceNum": 1,
       "extract": true,
       "mapping": "",
       "optionalData": "SIS_ID=FG123456",
   }
]

Itens Graduáveis e Colunas de Classificação Definições de Elementos

Nome do elemento

Descrição

Obrigatório

Tipo e tamanho máximo

código do curso

Código de identificação do lote identificar o curso ao qual esse item avaliável ou coluna de notas se aplica.

sim

Corda (256 caracteres)

nome

Título do item avaliável.

sim

String (333 caracteres)

itemType

Tipo de item avaliável para criar.

Valores possíveis: *EXERCÍCIO, *TESTE, PESQUISA, fórum de discussão, WIKI, blog, DIÁRIO, SELF_AND_PEER_TEST, *MANUAL_COLUMN, *WEIGHTED_COLUMN, TOTAL_COLUMN

*Cursos Ultra e Originais. Todos os outros apenas cursos originais.

sim

String (333 caracteres)

instruções

Instruções para o item graduável.

não

String (2000 caracteres)

anônimo

Se for verdade, o exercício ou Teste será criado com a Correção Anônima habilitada.

Para cursos ultra, a Avaliação Anônima exige que uma data de entrega seja definida para o item.

não

Booleano (Padrão falso)

grupo

Se for verdade, o exercício será criado como Envio em Grupo de Tipo de Exercício.

não

Booleano (Padrão falso)

contentAreaName

Localização do item graduável será criada.

Pode ser usado em cursos Ultra para provisionar uma subpasta e colocar conteúdo nela. O valor tem o formato "parent@>@child", onde "pai" é o nome da pasta de nível superior (pai) e "filho" é o nome da subpasta. Se a subpasta já existir, o exercício será adicionado à subpasta existente. Se a subpasta não existir, ela será criada na pasta pai.

não

String (255 caracteres)

disponível

Determina se o item é visível para os alunos.

não

Booleano (Padrão falso)

cor

Cor do link do item graduável em um curso Original. Nome da cor ou valor hexagonal.

Apenas cursos originais.

não

String (10 caracteres)

tentativas

Número de tentativas permitidas para o Teste ou Exercício.

não

Int (Padrão –1 para ilimitado)

monitoradas

Determina se o monitoramento de estatísticas está habilitado para o item graduável. Não se aplica às colunas de nota.

Apenas cursos originais.

não

Booleano (Padrão falso)

data de início

Exibir a partir da data.

não

Data

fim Data

Exibir até a data.

não

Data

data de entrega

Data de entrega do item Graduável.

não

Data

pontos

Pontos possíveis.

não

Float (Padrão 100.0)

gradeschema

Nome do esquema de notas como existe no Learn. Note que esse esquema pode ter sido criado usando o serviço web disponível no Exportação de Notas ou no Blackboard Learn

não

String (333 caracteres)

sequenceNum

Sequência de conteúdo do número de pedido exibido.

Apenas cursos originais.

não

Int

extrair

Verdadeiro/falso – Se verdadeiro, esta coluna será extraída da ferramenta de extração. Só se aplica quando a Jornada de Notas tiver o Provision Habilitado na página de Configurações de Saída.

não

String (333 caracteres)

mapeamento

Para uma coluna com peso, especifique os mapeamentos. O padrão é sem mapeamento, o que exige que o mapeamento seja realizado manualmente diretamente no Learn. Esses serão os pares de nome/porcentagem de itens avaliáveis, separados por uma vírgula, onde as porcentagens totalizam 100. Exemplo: exercício 1=30, Teste 1=30, Teste 2=40.

Para uma coluna Total, especifique apenas as colunas que devem ser incluídas no total. Por exemplo, exercício 1, Prova 1, exercício 2, Nota Final

não

String (333 caracteres)

optionalData

Pares chave/valor com cada conjunto de pares separados por dois pontos e chave/valores separados por um sinal de igual. Por exemplo: key1=value1:key2=value2

não

String (2000 caracteres)

Exemplo de resposta

 [
   {
       "status": "OK",
       "message": "Gradecolumn successfully created",
       "courseId": "course1",
       "name": "Final Grade"
   }
]

Exclua Colunas de Notas

Endpoint de serviço web

https://{{hostname}}//learn/api/v2/cc/gradejourney/gradeColumnDeleteAPI

Exemplo de Corpo JSON

[
   {
       "courseId": "course1",
       "name": "Final Grade"
   }
]

Definições de Elementos de Exclusão da Coluna de Notas

Nome do elemento

Descrição

Obrigatório

Tipo e tamanho máximo

código do curso

O curso código de identificação do lote.

sim

String (333 caracteres)

nome

O nome da coluna a ser excluída.

sim

String (333 caracteres)

Exemplo de resposta

[
   {
       "status": "OK",
       "message": "Grade column successfully deleted",
       "courseId": "TG-TEST-ORIG",
       "name": "Delete Column"
   }
]

Defina a Nota Externa

(disponível apenas para cursos originais)

Endpoint de serviço web

https://{{hostname}}/learn/api/v2/cc/gradejourney/externalGradeColumnAPI

Exemplo de Corpo JSON

[
   {
       "courseId": "course1",
       "name": "Final Grade"
   }
]

Definições externas de elementos da coluna de notas

Nome do elemento

Descrição

Obrigatório

Tipo e tamanho máximo

código do curso

O curso código de identificação do lote.

sim

String (333 caracteres)

nome

O nome da coluna será definido como Nota Externa.

sim

String (333 caracteres)

Exemplo de resposta

 [
   {
       "status": "OK",
       "message": "External grade column successfully updated",
       "courseId": "course1",
       "name": "Final Grade"
   }
]

Metadados de Criação de Matrícula

Endpoint de serviço web

https://{{hostname}}/learn/api/v2/cc/gradejourney/userMetadataAPI

Exemplo de Corpo JSON

[
   {
       "courseId": "course1",
       "userId": "student1",
       "optionalData": "EnrollType=LetterGrade"
   },
   {
       "courseId": "course1",
       "userId": "student2",
       "optionalData": "EnrollType=Audit"
   }
]

Definições de Elementos de Metadados de Matrícula

Nome do elemento

Descrição

Obrigatório

Tipo e tamanho máximo

código do curso

O curso código de identificação do lote.

sim

String (333 caracteres)

userId

O usuário código de identificação do lote.

sim

String (333 caracteres)

optionalData

Pares chave/valor com cada conjunto de pares separados por dois pontos e chave/valores separados por um sinal de igual. Por exemplo: key1=value1:key2=value2

não

String (2000 caracteres)

Exemplo de resposta

 [
   {
       "status": "OK",
       "message": "User metadata successfully created",
       "courseId": "course01",
       "name": "student01"
   },
   {
       "status": "OK",
       "message": "User metadata successfully created",
       "courseId": "course02",
       "name": "student02"
   }
]

Valor de Nota de Atualização

Endpoint de serviço web

https://{{hostname}}/learn/api/v2/cc/gradejourney/gradeValueAPI

Exemplo de Corpo JSON

[ 
   { 
       "courseId": "course001", 
       "userId": "user1", 
       "name": "FINAL GRADE", 
       "value": "B" 
   } 
]

Definições de Elementos de Atualização de Valor de Nota

Nome do elemento

Descrição

Obrigatório

Tipo e tamanho máximo

código do curso

O curso código de identificação do lote.

sim

String (333 caracteres)

userId

O usuário código de identificação do lote.

sim

String (333 caracteres)

nome

A coluna cujo valor deve ser atualizado.

sim

String (333 caracteres)

valor

O valor da nota para atualizar.

sim

String (333 caracteres)

Exemplo de resposta

[
   {
       "status": "OK",
       "message": "Grade value successfully added",
       "courseId": "course1",
       "name": "Final Grade"
   }
]