Partilhar via


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 do curso de aprendizagem pode ser um de dois tipos:

Utilize este método para criar qualquer tipo de atividade.

Nota: as atividades do curso de aprendizagem só podem ser geridas por um fornecedor quando isCourseAcitvitySyncEnabled está definido como true. Para atualizar o valor, utilize o método Update learningProvider .

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
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 do pedido, utilize @odata.type para especificar o tipo de recurso learningCourseActivity que está a criar (learningAssignment ou learningSelfInitiated) e inclua as propriedades desse tipo, conforme listado na tabela seguinte.

Propriedade Tipo Descrição
assignedDateTime DateTimeOffset Data atribuída para a atividade do curso. Opcional.
assignmentType assignmentType O tipo de tarefa para a atividade do curso. Os valores possíveis são: required, recommended, unknownFutureValue. Obrigatório.
assignerUserId Cadeia de caracteres O ID de utilizador do detentor. Opcional.
completedDateTime DateTimeOffset A data e hora em que a tarefa foi concluída. Opcional.
completionPercentage Int32 A percentagem do curso concluído pelo utilizador. Opcional. Se for fornecido um valor, tem de estar entre 0 e 100 (inclusive).
dueDateTime DateTimeOffset Data para conclusão da atividade do curso. Opcional.
externalCourseActivityId Cadeia de caracteres Um ID de atividade do curso gerado pelo fornecedor. Opcional.
id Cadeia de caracteres O ID gerado para um pedido que pode ser utilizado para efetuar mais interações com as APIs de atividade do curso.
learningContentId Cadeia de caracteres O ID do conteúdo de aprendizagem criado no Viva Learning. Obrigatório.
learningProviderId Cadeia de caracteres O ID de registo do fornecedor. Obrigatório.
learnerUserId Cadeia de caracteres O ID de utilizador do formando a quem a atividade é atribuída. Obrigatório.
notes String Notas para a atividade do curso. Opcional.
registrationId Cadeia de caracteres ID do fornecedor. O ID é gerado quando o fornecedor se regista no Viva Learning. Obrigatório.
startedDateTime DateTimeOffset A data e hora em que o curso auto-iniciado foi iniciado pelo formando. 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, este método devolve 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 seguinte 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 do curso de aprendizagem auto-iniciada

O exemplo seguinte 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"
}