Erstellen von learningCourseActivity

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Erstellen Sie ein neues learningCourseActivity-Objekt .

Es gibt zwei Arten von Lernkursaktivitäten:

Verwenden Sie diese Methode, um einen der beiden Aktivitätstypen zu erstellen.

Hinweis: Lernkursaktivitäten können nur dann von einem Anbieter verwaltet werden, wenn isCourseAcitvitySyncEnabled auf trueeingestellt ist. Verwenden Sie zum Aktualisieren des Werts die Update-learningProvider-Methode .

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) Nicht unterstützt Nicht unterstützt
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application LearningAssignedCourse.ReadWrite.All LearningSelfInitiatedCourse.ReadWrite.All

HTTP-Anforderung

POST /employeeExperience/learningProviders/{registrationId}/learningCourseActivities

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext @odata.type den Typ der learningCourseActivity-Ressource an, die Sie erstellen (learningAssignment oder learningSelfInitiated), und schließen Sie die Eigenschaften dieses Typs ein, wie in der folgenden Tabelle aufgeführt.

Eigenschaft Typ Beschreibung
assignedDateTime DateTimeOffset Zugewiesenes Datum für die Kursaktivität. Optional.
assignmentType assignmentType Der Zuordnungstyp für die Kursaktivität. Die möglichen Werte sind: required, recommended, unknownFutureValue. Erforderlich.
assignerUserId Zeichenfolge Die Benutzer-ID der zuweisenden Person. Optional.
completedDateTime DateTimeOffset Das Datum und die Uhrzeit, zu der die Aufgabe abgeschlossen wurde. Optional.
completionPercentage Int32 Der Prozentsatz des Kurses, den der Benutzer abgeschlossen hat. Optional. Wenn ein Wert angegeben wird, muss er zwischen 0 und 100 (einschließlich) liegen.
dueDateTime DateTimeOffset Fälligkeitsdatum für die Kursaktivität. Optional.
externalCourseActivityId Zeichenfolge Eine vom Anbieter generierte Kursaktivitäts-ID. Optional.
id Zeichenfolge Die generierte ID für eine Anforderung, die verwendet werden kann, um weitere Interaktionen mit den Kursaktivitäts-APIs vorzunehmen.
learningContentId Zeichenfolge Die ID der in Viva Learning erstellten Lerninhalte. Erforderlich.
learningProviderId Zeichenfolge Die Registrierungs-ID des Anbieters. Erforderlich.
learnerUserId Zeichenfolge Die Benutzer-ID des Lernenden, dem die Aktivität zugewiesen ist. Erforderlich.
notes String Notizen für die Kursaktivität. Optional.
registrationId Zeichenfolge ID des Anbieters. Die ID wird generiert, wenn sich der Anbieter bei Viva Learning registriert. Erforderlich.
startedDateTime DateTimeOffset Datum und Uhrzeit, zu dem der selbst initiierte Kurs vom Lernenden begonnen wurde. Optional.
status courseStatus Der Status der Kursaktivität. Die möglichen Werte sind: notStarted, inProgress, completed. Erforderlich.

Antwort

Bei erfolgreicher Ausführung gibt diese Methode einen 201 Created Antwortcode und ein learningCourseActivity-Objekt vom Typ learningAssignment oder learningSelfInitiated im Antworttext zurück.

Beispiele

Beispiel 1: Erstellen einer zugewiesenen Lernkursaktivität

Das folgende Beispiel zeigt, wie Sie eine learningAssignment-Aktivität erstellen.

Anforderung

Das folgende Beispiel zeigt die Antwort.

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"
}

Antwort

Das folgende Beispiel zeigt die Antwort.

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"
}

Beispiel 2: Erstellen einer selbst initiierten Lernkursaktivität

Im folgenden Beispiel wird eine learningSelfInitiate-Aktivität erstellt.

Anforderung

Das folgende Beispiel zeigt die Antwort.

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"
}

Antwort

Das folgende Beispiel zeigt die Antwort.

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"
}