API-Änderungen in der Version September 2026 von Adobe Learning Manager
API zum Überprüfen des Katalogzugriffs für Lernobjekte
Bestimmen Sie, ob der aktuelle Teilnehmer direkten Katalogzugriff auf ein oder mehrere Lernobjekte hat, unabhängig davon, ob der Teilnehmer diesen Inhalt über einen Lernpfad oder eine Zertifizierung erreicht hat.
Zweck der API
Wenn ein Teilnehmer einen Lernpfad oder eine Zertifizierung öffnet, kann er die einzelnen darin enthaltenen Kurse durchsuchen, auch wenn ihm ein bestimmter Kurs nicht direkt über einen Katalog zugewiesen wurde. Dies unterstützt die Suche nach Inhalten: können Teilnehmer den Inhalt eines Lernpfads untersuchen, bevor sie entscheiden, ob sie ihn weiterverfolgen möchten.
Wenn Sie einen Kurs auf diese Weise anzeigen können, sollte dies jedoch nicht automatisch bedeuten, dass sich der Teilnehmer dafür registrieren kann. Die Registrierung sollte davon abhängen, ob der Teilnehmer direkten Katalogzugriff auf diesen bestimmten Kurs hat, nicht nur den indirekten Zugriff über einen enthaltenden Lernpfad.
Mit dieser API können Sie für einen bestimmten Teilnehmer überprüfen, ob auf ein oder mehrere Lernobjekte direkt über einen Katalog zugegriffen werden kann, der ihm zugewiesen wurde. Verwenden Sie das Ergebnis, um die Benutzeroberfläche für die Registrierung zu steuern, z. B. wenn die Option “Registrieren” nur angezeigt wird, wenn der direkte Katalogzugriff bestätigt wurde, während die Kursseite selbst in beiden Fällen sichtbar bleibt.
Endpunkt
GET /primeapi/v2/learningObjects/isMemberOfVisibleCatalogs
Abfrageparameter
Beispielanforderung
GET /primeapi/v2/learningObjects/isMemberOfVisibleCatalogs?ids=course%3A2400159%2Ccourse%3A2400160%2Ccourse%3A2400161%2Ccourse%3A2400162
Accept: application/vnd.api+json
Authorization: oauth <access-token>
Beispielantwort - 200 OK
{
"course:2400162": false,
"course:2400161": false,
"course:2400160": true,
"course:2400159": true
}
Antwortcodes
Beispielfehlerantwort
{
"status": "BAD_REQUEST",
"title": "Bad request. Check url, params and headers",
"source": {
"info": "Either LO id is blank or not as per public api specification"
}
}
Diese API in Ihrer Integration verwenden
Ein häufiger Anwendungsfall ist eine Kursseite, die ein Teilnehmer erreicht, indem er von einem Lernpfad aus navigiert. Sie möchten, dass die Kursseite selbst für die Erkennung zugänglich bleibt, während die Aktion Registrieren nur angezeigt wird, wenn der Teilnehmer direkten Katalogzugriff auf diesen Kurs hat.
- Wenn die Kursseite geladen wird, rufen Sie diesen Endpunkt mit der Lernobjekt-ID des Kurses auf.
- Wenn die Antwort für diese ID “true” zurückgibt, zeigen Sie die Option Registrieren an.
- Wenn die Antwort “false” zurückgibt, halten Sie die Kursseite sichtbar, den Titel, die Beschreibung und die Kursdetails, aber blenden Sie die Option Registrieren aus.
Job-API für Administratorprüfprotokollbericht apiaudittrailreport
Zweck der API
Der Administrator Audit Trail-Bericht listet die Konfigurationsänderungen auf, die an einer
Adobe Learning Manager-Konto bearbeiten. Beispielsweise Änderungen an “Grundlagen”, “Integrationen” oder
Erweiterte Kontoeinstellungen für einen bestimmten Datumsbereich. Zum Generieren des Prüfprotokollberichts müssen Konfigurationsänderungsdatensätze für den angeforderten Datumsbereich und die Einstellungstypen abgefragt und aggregiert werden. Je nach Größe des Bereichs und der Menge der Änderungen kann dies die Zeitlimits einer synchronen HTTP-Anforderung überschreiten, wodurch Client- oder Gateway-Timeouts riskiert werden.
Um dies zu vermeiden, wird der Bericht asynchron über die generische Job-API generiert:
-
Auftrag erstellen. Der Administrator sendet eine Anforderung, in der er den Berichtstyp, den Datumsbereich und die Einstellungstypen angibt. Die API gibt sofort eine Job-ID zurück, ohne auf die Kompilierung des Berichts zu warten.
-
Auftrag abfragen. Der Administrator ruft den Job regelmäßig anhand seiner ID ab, um seinen Status zu überprüfen. Wenn der Auftrag abgeschlossen ist, enthält die Antwort das Ergebnis oder einen Verweis darauf.
Basis-URL und Konventionen
/primeapi/v2application/vnd.api+json;charset=UTF-8 (JSON:API)x-acap-account-Kopfzeile, die das Konto des anrufenden Administrators identifiziertstatus nicht mehr QUEUED oder IN_PROGRESS istIDs
Der bei der Erstellung eines Auftrags zurückgegebene Auftrag “id” ist eine undurchsichtige Zeichenfolge (z. B.4593). Immer genau den id-Wert zurückgeben, den Sie vom Erstellungsvorgang erhalten haben
Antwort beim Abfragen des Status. Sie niemals konstruieren oder analysieren.
Authentifizierungsbereiche
Für jeden Endpunkt ist ein OAuth-Token mit dem folgenden Gültigkeitsbereich erforderlich. Das
Der aufrufende Benutzer muss über die Kontoadministratorrolle verfügen:
admin:writeBerichtsauftrag erstellen (ROLE_ADMINerforderlich)admin:readhat den Status und das Ergebnis eines Auftrags gelesen (ROLE_ADMINerforderlich).
Anforderungen eines Anrufers, der nicht ROLE_ADMIN für das Konto besitzt, sind
zurückgewiesen; Siehe Fehlerbehandlung
Endpunkte
Auftrag für einen Audit-Protokoll-Bericht erstellen
POST /primeapi/v2/jobs
Erstellt einen asynchronen Auftrag, der einen Bericht zum Konfigurationsänderungs-Audit-Protokoll generiert.
für den angegebenen Datumsbereich und die Einstellungstypen. Die Antwort wird sofort zurückgegeben
mit einer Auftragsressource im Status “QUEUED”; der Bericht selbst wird in der
Hintergrund.
Umfang: admin:write
jobTypegenerateConfigChangeAuditReport sein.payload.fromDate2026-09-15T00:00:00.000+05:30payload.toDate2026-09-23T23:59:59.000+05:30payload.settingTypesBasics, Integrations und Advanced.Beispielanforderungstext
{
"data": {
"type": "job",
"attributes": {
"jobType": "generateConfigChangeAuditReport",
"payload": {
"fromDate": "2026-09-15T00:00:00.000+05:30",
"toDate": "2026-09-23T23:59:59.000+05:30",
"settingTypes": ["Basics", "Integrations", "Advanced"]
}
}
}
}
Antwort: 202 Created Der Antworttext ist die Auftragsressource in seinem ursprünglichen
Status “QUEUED”.
{
"data": {
"id": "4593",
"type": "job",
"attributes": {
"jobType": "generateConfigChangeAuditReport",
"status": "QUEUED",
"dateCreated": "2026-09-23T18:12:04.000+05:30"
}
}
}
fromDate/toDate-Fenster, das sich über einen sehr großen Datumsbereich erstreckt, oder dasalle Einstellungstypen für ein Konto mit einem langen Änderungsverlauf anfordert, kann
die Verarbeitung dauert länger. Umfrage zum Endpunkt "Status abrufen" statt zum
vorausgesetzt, der Bericht ist nach einer festen Verzögerung fertig.
Abrufen des Status eines Prüfprotokollberichtsauftrags
GET /primeapi/v2/jobs/{id}
Gibt den aktuellen Status eines zuvor erstellten Auftrags zurück. Solange der Auftrag
wird noch ausgeführt, attributes.status ist QUEUED oder IN_PROGRESS undattributes.result ist nicht vorhanden. Sobald der Auftrag abgeschlossen ist, wird attributes.status
entweder COMPLETED mit dem Berichtsspeicherort in attributes.result oderFAILED, mit Fehlerdetails in attributes.error.
Umfang: admin:read
idBeispielantwort, während der Auftrag noch ausgeführt wird
{
"data": {
"id": "4593",
"type": "job",
"attributes": {
"jobType": "generateConfigChangeAuditReport",
"status": "IN_PROGRESS",
"dateCreated": "2026-09-23T18:12:04.000+05:30"
}
}
}
Beispielantwort nach Abschluss des Auftrags
{
"data": {
"id": "4593",
"type": "job",
"attributes": {
"jobType": "generateConfigChangeAuditReport",
"status": "COMPLETED",
"dateCreated": "2026-09-23T18:12:04.000+05:30",
"dateCompleted": "2026-09-23T18:12:41.000+05:30",
"result": {
"downloadUrl": "https://learningmanager.adobe.com/primeapi/v2/jobs/4593/download",
"expiresAt": "2026-09-24T18:12:41.000+05:30"
}
}
}
}
Ressourcenschema
Auftragsattribute
idjobTypegenerateConfigChangeAuditReport für diesen BerichtstatusQUEUED, IN_PROGRESS, COMPLETED oder FAILEDdateCreateddateCompletedstatus COMPLETED oder FAILED istpayloadresultstatus COMPLETED ist (eingebettet - siehe unten)errorstatus FAILED istNutzlast (eingebettet in die Erstellungsanforderung)
fromDatetoDatesettingTypesBasics, Integrations, AdvancedErgebnis (eingebettet in einen abgeschlossenen Auftrag)
downloadUrlexpiresAtdownloadUrl nicht mehr gültig ist; eine neue Statusprüfung anfordern, um nach diesem Zeitpunkt einen neuen Link zu erhaltenFehlerbehandlung audit-trail-report-error-handling
Für diese Endpunkte gelten die folgenden Codes:
BAD_REQUESTtoDate ist älter als fromDate, settingTypes ist leer oder enthält einen nicht unterstützten Wert, oder ein Datum ist ungültig ISO-8601 - nur Endpunkt erstellenUNAUTHORIZED_ACCESSFORBIDDENROLE_ADMIN nicht im Konto.OBJECT_DOESNT_EXISTBeispielfehlerantwort
{
"status": "BAD_REQUEST",
"title": "Bad request. Check url, params and headers",
"source": {
"info": "toDate must be on or after fromDate"
}
}
Diese API in Ihrer Integration verwenden
Ein typischer Anwendungsfall ist eine Administratoraktion zum Herunterladen des Audit-Protokolls im Dialogfeld "
Kontoeinstellungen angezeigt.
- Wenn der Administrator einen Datumsbereich und einen oder mehrere Einstellungstypen auswählt und
bestätigt, rufen Sie den Endpunkt create-job mit diesen Werten auf. - Speichern Sie den zurückgegebenen Auftrag “
id”, und rufen Sie den Endpunkt “Auftragsstatus abrufen” auf einer
ein angemessenes Intervall (beispielsweise alle paar Sekunden). - Während
statusQUEUEDoderIN_PROGRESSist, zeigen Sie weiterhin einen Fortschrittsstatus an
in der Benutzeroberfläche. - Wenn
statuszuCOMPLETEDwird, verwenden Sieresult.downloadUrl, um die
Der Administrator lädt den Bericht herunter, bevorexpiresAterfolgreich ist. - Wenn
statuszuFAILEDwird, übergeben Sieerroran den Administrator und lassen Sie ihn
erneut versuchen.