Criar learningCourseActivity

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Crie um novo objeto learningCourseActivity .

Uma atividade de curso de aprendizado pode ser de dois tipos:

Use esse método para criar qualquer tipo de atividade.

Observação: as atividades do curso de aprendizado podem ser gerenciadas por um provedor somente quando isCourseAcitvitySyncEnabled estiver definido como true. Para atualizar o valor, use o método Update learningProvider .

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet
✅ ❌ ❌ ❌

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) Sem suporte. Sem suporte.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application LearningAssignedCourse.ReadWrite.All LearningSelfInitiatedCourse.ReadWrite.All

Solicitação HTTP

POST /employeeExperience/learningProviders/{registrationId}/learningCourseActivities

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, use @odata.type para especificar o tipo de recurso learningCourseActivity que você está criando (learningAssignment ou learningSelfInitiated) e inclua as propriedades desse tipo, conforme listado na tabela a seguir.

Propriedade Tipo Descrição
assignedDateTime DateTimeOffset Data atribuída para a atividade do curso. Opcional.
assignmentType assignmentType O tipo de atribuição para a atividade do curso. Os valores possíveis são: required, recommended, unknownFutureValue. Obrigatório.
assignerUserId Cadeia de caracteres A ID de usuário do cedente. Opcional.
completedDateTime DateTimeOffset A data e hora em que a atribuição foi concluída. Opcional.
completionPercentage Int32 A porcentagem do curso concluído pelo usuário. Opcional. Se um valor for fornecido, ele deverá estar entre 0 e 100 (inclusivo).
dueDateTime DateTimeOffset Data de conclusão para a atividade do curso. Opcional.
externalCourseActivityId Cadeia de caracteres Uma ID de atividade do curso gerada pelo provedor. Opcional.
id Cadeia de caracteres A ID gerada para uma solicitação que pode ser usada para fazer outras interações com as APIs de atividade do curso.
learningContentId Cadeia de caracteres A ID do conteúdo de aprendizado criado no Viva Learning. Obrigatório.
learningProviderId Cadeia de caracteres A ID de registro do provedor. Obrigatório.
learnerUserId Cadeia de caracteres A ID de usuário do aluno a quem a atividade é atribuída. Obrigatório.
notes String Notas para a atividade do curso. Opcional.
registrationId Cadeia de caracteres ID do provedor. A ID é gerada quando o provedor se registra no Viva Learning. Obrigatório.
startedDateTime DateTimeOffset A data e hora em que o curso iniciado automaticamente foi iniciado pelo aluno. Opcional.
status courseStatus O status da atividade do curso. Os valores possíveis são: notStarted, inProgress, completed. Obrigatório.

Resposta

Se for bem-sucedido, esse método retornará um 201 Created código de resposta e um objeto learningCourseActivity do tipo learningAssignment ou learningSelfInitiated no corpo da resposta.

Exemplos

Exemplo 1: Criar uma atividade de curso de aprendizagem atribuída

O exemplo a seguir mostra como criar uma atividade learningAssignment .

Solicitação

O exemplo a seguir mostra a solicitação.

POST https://graph.microsoft.com/beta/employeeExperience/learningProviders/01e8f81b-3060-4dec-acf0-0389665a0a38/learningCourseActivities
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.learningAssignment",
  "assignedDateTime": "2021-05-11T22:57:17+00:00",
  "assignmentType": "required",
  "assignerUserId": "cea1684d-57dc-438d-a9d1-e666ec1a7f3d",
  "completedDateTime": null,
  "completionPercentage": 20,
  "dueDateTime": {
    "dateTime": "2022-09-22T16:05:00.0000000",
    "timeZone": "UTC"
  },
  "externalCourseActivityId": "12a2228a-e020-11ec-9d64-0242ac120002",
  "learningContentId": "57baf9dc-e020-11ec-9d64-0242ac120002",
  "learningProviderId": "01e8f81b-3060-4dec-acf0-0389665a0a38",
  "learnerUserId": "7ba2228a-e020-11ec-9d64-0242ac120002",
  "notes": {
    "contentType": "text",
    "content": "required assignment added for user"
  },
  "status": "notStarted"
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.learningAssignment",
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#learningProviders('13727311-e7bb-470d-8b20-6a23d9030d70')/learningCourseActivities('7ba2228a-e020-11ec-9d64-0242ac120002')$entity",
  "assignedDateTime": "2021-05-11T22:57:17+00:00",
  "assignmentType": "required",
  "assignerUserId": "cea1684d-57dc-438d-a9d1-e666ec1a7f3d",
  "completedDateTime": null,
  "completionPercentage": 20,
  "externalCourseActivityId": "12a2228a-e020-11ec-9d64-0242ac120002",
  "id": "7ba2228a-e020-11ec-9d64-0242ac120002:749c8786-99bb-4b3b-8d5d-586428f6aaa3",
  "dueDateTime": {
    "dateTime": "2022-09-22T16:05:00.0000000",
    "timeZone": "UTC"
  },
  "learningContentId": "57baf9dc-e020-11ec-9d64-0242ac120002",
  "learningProviderId": "01e8f81b-3060-4dec-acf0-0389665a0a38",
  "learnerUserId": "7ba2228a-e020-11ec-9d64-0242ac120002",
  "notes": {
    "contentType": "text",
    "content": "required assignment added for user"
  },
  "status": "notStarted"
}

Exemplo 2: Criar uma atividade de curso de aprendizado iniciado automaticamente

O exemplo a seguir cria uma atividade learningSelfInitiated .

Solicitação

O exemplo a seguir mostra a solicitação.

POST https://graph.microsoft.com/beta/employeeExperience/learningProviders/01e8f81b-3060-4dec-acf0-0389665a0a38/learningCourseActivities
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.learningSelfInitiatedCourse",
  "completedDateTime": null,
  "completionPercentage": 20,
  "externalCourseActivityId": "12a2228a-e020-11ec-9d64-0242ac120002",
  "learningContentId": "57baf9dc-e020-11ec-9d64-0242ac120002",
  "learnerUserId": "7ba2228a-e020-11ec-9d64-0242ac120002",
  "startedDateTime": "2021-05-21T22:57:17+00:00",
  "status": "inProgress"
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.learningSelfInitiatedCourse",
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#learningProviders('13727311-e7bb-470d-8b20-6a23d9030d70')/learningCourseActivities('be2f4d76-e020-11ec-9d64-0242ac120002')$entity",
  "completedDateTime": null,
  "completionPercentage": 20,
  "externalCourseActivityId": "12a2228a-e020-11ec-9d64-0242ac120002",
  "id": "7ba2228a-e020-11ec-9d64-0242ac120002:749c8786-99bb-4b3b-8d5d-586428f6aaa3",
  "learningContentId": "57baf9dc-e020-11ec-9d64-0242ac120002",
  "learningProviderId": "01e8f81b-3060-4dec-acf0-0389665a0a38",
  "learnerUserId": "7ba2228a-e020-11ec-9d64-0242ac120002",
  "startedDateTime": "2021-05-21T22:57:17+00:00",
  "status": "inProgress"
}