Compartilhar via


Criar learningCourseActivity

Namespace: microsoft.graph

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: um fornecedor só pode gerir atividades do curso de aprendizagem 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 A Microsoft Entra ID do detentor. Opcional.
completedDateTime DateTimeOffset A data e hora em que a tarefa foi concluída. Opcional.
completionPercentage Int32 A percentagem do curso que o utilizador conclui. Opcional. Se for fornecido um valor, tem de estar entre 0 e 100 (inclusive).
dueDateTime DateTimeOffset A 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 interagir ainda mais 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 A Microsoft Entra ID 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 formando iniciou um curso auto-iniciado. 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.

Se não for bem-sucedido, este método devolve uma das respostas abaixo:

Cenário Código HTTP Código Mensagem Detalhes
Proibido 403 Proibido Não tem um plano de serviço adequado para este pedido.
Solicitação inválida 400 badRequest Este fornecedor não está ativado para o inquilino especificado.
Solicitação inválida 400 badRequest Ocorreu um problema com o seu pedido. Certifique-se de que o registrationId introduzido é válido ou está registado no seu inquilino.
Erro de servidor interno 500 internalServerError Erro de servidor interno.
Pedido limitado 429 tooManyRequests {"code": "tooManyRequests","message": "Retry after {noOfMinutes} minutes"}.
Serviço indisponível 503 serviceUnavailable {"code": "serviceUnavailable","message": "Retry after {noOfMinutes} minutes"}.
Falha de várias validações de campos 400 badRequest badRequest {"code": "badRequest","message": "Input field {fieldName}shouldn't be empty"}, {"code": "badRequest","message": "Input field {fieldName} is required"}, {"code": "badRequest","message": "Input field {fieldName}length exceeded than {expectedLength}"}.
Proibido 403 O fornecedor não é válido para criar a atividade do curso para o conteúdo de aprendizagem fornecido Quando registrationId/learningProviderId não corresponde ao fornecedor com o qual o learningContent é criado.
Proibido 403 A licença de utilizador não é válida para executar a operação Quando o utilizador para o qual a atribuição está a ser criada não tem uma licença premium.

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 uma solicitação.

POST https://graph.microsoft.com/v1.0/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/v1.0/$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 uma solicitação.

POST https://graph.microsoft.com/v1.0/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/v1.0/$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"
}