Erstellen von learningCourseActivity

Namespace: microsoft.graph

Erstellen Sie ein neues learningCourseActivity-Objekt .

Eine Lernkursaktivität kann eine von zwei Arten sein:

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

Hinweis: Ein Anbieter kann Lernkursaktivitäten nur verwalten, wenn isCourseAcitvitySyncEnabled auf truefestgelegt ist. Verwenden Sie zum Aktualisieren des Werts die Update learningProvider-Methode .

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

Globaler Dienst US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. 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
Anwendung LearningAssignedCourse.ReadWrite.All LearningSelfInitiatedCourse.ReadWrite.All

HTTP-Anforderung

POST /employeeExperience/learningProviders/{registrationId}/learningCourseActivities

Anforderungsheader

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

Anforderungstext

Verwenden Sie @odata.type im Anforderungstext, um den Typ der learningCourseActivity-Ressource anzugeben, 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. Mögliche Werte sind: required, recommended und unknownFutureValue. Erforderlich.
assignerUserId String Die Microsoft Entra ID des Zuweisenden. Optional.
completedDateTime DateTimeOffset Das Datum und die Uhrzeit, zu dem die Zuordnung abgeschlossen wurde. Optional.
completionPercentage Int32 Der Prozentsatz des Kurses, den der Benutzer abschließt. Optional. Wenn ein Wert angegeben wird, muss er zwischen 0 und 100 (einschließlich) liegen.
dueDateTime DateTimeOffset Das Fälligkeitsdatum für die Kursaktivität. Optional.
externalCourseActivityId String Eine vom Anbieter generierte Kursaktivitäts-ID. Optional.
id String Die generierte ID für eine Anforderung, die für die weitere Interaktion mit den Kursaktivitäts-APIs verwendet werden kann.
learningContentId String Die ID des in Viva Learning erstellten Lerninhalts. Erforderlich.
learningProviderId String Die Registrierungs-ID des Anbieters. Erforderlich.
learnerUserId String Die Microsoft Entra ID des Lernenden, dem die Aktivität zugewiesen ist. Erforderlich.
notes String Hinweise für die Kursaktivität. Optional.
registrationId String ID des Anbieters. Die ID wird generiert, wenn sich der Anbieter bei Viva Learning registriert. Erforderlich.
startedDateTime DateTimeOffset Das Datum und die Uhrzeit, zu dem der Lernende einen selbst initiierten Kurs begonnen hat. Optional.
status courseStatus Die status der Kursaktivität. Mögliche Werte sind: notStarted, inProgress und completed. Erforderlich.

Antwort

Wenn die Methode erfolgreich verläuft, werden der 201 Created Antwortcode und ein learningCourseActivity-Objekt vom Typ learningAssignment oder learningSelfInitiated im Antworttext zurückgegeben.

Wenn die Methode nicht erfolgreich ist, wird eine der folgenden Antworten zurückgegeben:

Szenario HTTP-Code Code Nachricht Details
Verboten (Forbidden) 403 Verboten (Forbidden) Sie verfügen nicht über einen geeigneten Serviceplan für diese Anforderung.
Bad request (Ungültige Anforderung) 400 badRequest Dieser Anbieter ist für den angegebenen Mandanten nicht aktiviert.
Bad request (Ungültige Anforderung) 400 badRequest Es ist ein Problem mit Ihrer Anforderung aufgetreten. Stellen Sie sicher, dass die eingegebene registrationId für Ihren Mandanten gültig oder registriert ist.
Interner Serverfehler 500 internalServerError Internal server error. (Interner Serverfehler)
Anforderung gedrosselt 429 tooManyRequests {"code": "tooManyRequests","message": "Wiederholen sie nach {noOfMinutes} Minuten"}.
Dienst nicht verfügbar (Service Unavailable) 503 serviceUnavailable {"code": "serviceUnavailable","message": "Wiederholung nach {noOfMinutes} Minuten"}.
Fehler bei mehreren Feldüberprüfungen 400 badRequest badRequest {"code": "badRequest","message": "Eingabefeld {fieldName}darf nicht leer sein"}, {"code": "badRequest","message": "Eingabefeld {fieldName} is required"}, {"code": "badRequest","message": "Eingabefeld {fieldName}length exceeded than {expectedLength}"}.
Verboten (Forbidden) 403 Der Anbieter ist nicht gültig, um Kursaktivitäten für die angegebenen Lerninhalte zu erstellen. Wenn die registrationId/learningProviderId nicht mit dem Anbieter übereinstimmt, mit dem die learningContent erstellt wird.
Verboten (Forbidden) 403 Die Benutzerlizenz ist ungültig, um den Vorgang auszuführen. Wenn der Benutzer, für den die Zuweisung erstellt wird, keine Premium-Lizenz besitzt.

Beispiele

Beispiel 1: Erstellen einer zugewiesenen Lernkursaktivität

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

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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

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

Beispiel 2: Erstellen einer selbstinitiierte Lernkursaktivität

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

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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

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