API-Änderungen in der Version August 2026 von Adobe Learning Manager

Admin-API für Benutzergruppen in Adobe Learning Manager

In dieser Version werden drei neue öffentliche API-Endpunkte mit Administratorbereich für die programmgesteuerte Verwaltung benutzerdefinierter Benutzergruppen hinzugefügt. Sie können benutzerdefinierte Benutzergruppen ohne die Admin-App erstellen, umbenennen und löschen. So können Sie die Gruppenverwaltung als Teil Ihrer Identitäts- oder Bereitstellungsarbeitsabläufe automatisieren.

Diese Endpunkte funktionieren nur mit benutzerdefinierten Benutzergruppen. Systemverwaltete Gruppen wie die Gruppe Alle Benutzer und automatisch generierte Benutzergruppen verfügen über den Schreibschutz: true in der API-Antwort und kann nicht über diese Endpunkte geändert oder gelöscht werden.

Anforderungen für die API-Authentifizierung finden Sie unter Adobe Learning Manager API-Authentifizierung.

API-Endpunkte für Benutzergruppen

Für alle drei Endpunkte ist ein Administratorzugriffstoken mit Schreibberechtigungen (ROLE_ADMIN) erforderlich.

Häufige Anforderungsheader

Für alle drei Endpunkte sind die folgenden Kopfzeilen erforderlich.

Authorization: Bearer \<access-token\>
X-acap-user: \<user-id\>
X-acap-account: \<account-id\>
X-acap-caller-role: ROLE_ADMIN
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

Benutzergruppe erstellen

POST /primeapi/v2/userGroups

Erstellt eine neue benutzerdefinierte Benutzergruppe mit einer anfänglichen Liste von Mitgliedern. Die Gruppe steht sofort für die Verwendung in der Admin-App zur Verfügung.

Anforderungstext

{
  "name": "Marketing Team",
  "description": "Custom user group for marketing onboarding",
  "data": [
    { "type": "user", "id": "11282373" },
    { "type": "user", "id": "11282374" }
  ]
}

Anforderungsparameter

Hinweis: Das Datenarray wird nur bei der Erstellung verwendet, um die erste Elementliste festzulegen. Um Mitglieder nach der Erstellung hinzuzufügen oder zu entfernen, verwenden Sie die vorhandenen Endpunkte der Benutzergruppenmitgliedschaft.

Antwort 201 erstellt

{
  "links": {
    "self": "https://<host>/primeapi/v2/userGroups"
  },
  "data": {
    "id": "2769204",
    "type": "userGroup",
    "attributes": {
      "dateCreated": "2026-06-04T14:19:53.000Z",
      "description": "Custom user group for marketing onboarding",
      "name": "Marketing Team",
      "readOnly": false,
      "userCount": 2
    }
  }
}

POST der Validierungsregeln

Benutzergruppe aktualisieren

PUT /primeapi/v2/userGroups/{id}

Aktualisiert den Namen und/oder die Beschreibung einer vorhandenen benutzerdefinierten Benutzergruppe. Dieser Endpunkt kann keine Gruppenmitglieder hinzufügen oder entfernen.

Beide Felder können weggelassen werden. Wenn ein Feld weggelassen wird, bleibt sein aktueller Wert unverändert. Durch Übergeben des NULL-Werts für die Beschreibung wird dieser gelöscht. Das Übergeben einer leeren Zeichenfolge für den Namen wird abgelehnt.

Anforderungstext

{
  "name": "Updated Group Name",
  "description": "Updated description text"
}

Anforderungsparameter

Antwort 200 OK

{
  "data": {
    "type": "userGroup",
    "id": "2767870",
    "attributes": {
      "name": "Updated Group Name",
      "description": "Updated description text",
      "readOnly": false,
      "state": "Active",
      "userCount": 3
    }
  }
}

Validierungsregeln PUT

Benutzergruppe löschen

DELETE /primeapi/v2/userGroups/{id}

Markiert die angegebene benutzerdefinierte Benutzergruppe als gelöscht. Der Gruppendatensatz wird nicht endgültig entfernt . Sein Status ist auf GELÖSCHT festgelegt, was ihn in der Admin-App nicht sichtbar und für die Verwendung in neuen Konfigurationen nicht berechtigt macht. Die Gruppen-ID kann nicht wiederverwendet werden.

Anforderungsbeispiel

DELETE /primeapi/v2/userGroups/2767870
Authorization: Bearer <access-token>
X-acap-user: <user-id>
X-acap-account: <account-id>
X-acap-caller-role: ROLE_ADMIN

Antwort 204 Kein Inhalt

Der Antworttext ist leer.

Hinweis: DELETE ist nicht imposant. Wenn Sie eine zweite DELETE-Anforderung an dieselbe Gruppen-ID senden, wird der Fehler 400 mit dem Code DELETED_USERGROUP zurückgegeben, nicht 204. Behandeln Sie eine 400 DELETED_USERGROUP-Antwort als Bestätigung, dass die Gruppe bereits gelöscht wurde. Das Massenlöschen wird nicht unterstützt. jede Gruppe erfordert eine separate DELETE-Anforderung.

DELETE für Validierungsregeln

Externe Lern-API in Adobe Learning Manager

In dieser Version werden fünf neue API-Endpunkte für Teilnehmer für die Funktion “Externes Lernen” hinzugefügt. Mit diesen Endpunkten können Teilnehmer externe Lernübermittlungen programmgesteuert erstellen, abrufen und aktualisieren, z. B. über eine mobile App, ein integriertes HR-System oder ein benutzerdefiniertes Lernportal.

Der externe Lern-Workflow über die API spiegelt den Workflow in der Teilnehmer-App wider: Wenn ein Teilnehmer Schulungsdetails und ein optionales Nachweisdokument einreicht, erhält sein direkter Manager eine Benachrichtigung, um die Einreichung zu überprüfen, und bei Genehmigung wird der Datensatz im Transkript des Teilnehmers angezeigt.

Alle fünf Endpunkte sind teilnehmerspezifisch. Ein Teilnehmer kann nur auf seine eigenen Einreichungen zugreifen - die API gibt einen Fehler zurück, wenn ein Teilnehmer versucht, auf die Daten eines anderen Teilnehmers zuzugreifen.

Anforderungen für die API-Authentifizierung finden Sie unter Adobe Learning Manager API-Authentifizierung.

Externe Lern-API-Endpunkte

Alle Endpunkte erfordern ein Teilnehmerzugriffstoken (ROLE_LEARNER).

Häufige Anforderungsheader

Authorization: Bearer <access-token>
X-acap-user: <user-id>
X-acap-account: <account-id>
X-acap-caller-role: ROLE_LEARNER
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json (POST and PUT only)

Lebenszyklus des Übermittlungsstatus

APPROVED (Genehmigt) und REJECTED (Zurückgewiesen) sind Terminalstatus. Eine abgelehnte Einreichung kann nicht erneut geöffnet werden. der Teilnehmer muss eine neue Einreichung erstellen.

Kontoformularkonfiguration abrufen

GET /primeapi/v2/externalLearningSettings

Gibt die Formularkonfiguration auf Kontoebene zurück. Rufen Sie diesen Endpunkt auf, bevor Sie ein Übermittlungsformular rendern. Die Antwort definiert, welche Felder angezeigt werden sollen, welche obligatorisch sind, ihre Datentypen und alle vom Administrator konfigurierten benutzerdefinierten Felder.

Überprüfen Sie das aktivierte Attribut der obersten Ebene, bevor Sie fortfahren. Wenn “false”, ist die Funktion “Externes Lernen” für dieses Konto nicht aktiv, und die Übermittlungsendpunkte geben Fehler zurück.

Antwort 200 OK

{
  "data": {
    "id": "8627",
    "type": "externalLearningSettings",
    "attributes": {
      "enabled": true,
      "updatedAt": "2026-06-05T06:51:20.000Z",
      "coreFields": [
        { "id": "title", "type": "TEXT", "mandatory": true, "editable": false, "order": 0 },
        { "id": "description_notes", "type": "TEXT", "mandatory": false, "editable": true, "order": 1 },
        { "id": "date", "type": "TIMESTAMP", "mandatory": false, "editable": true, "order": 2 },
        { "id": "score", "type": "NUMBER", "mandatory": true, "editable": true, "order": 3 },
        { "id": "duration", "type": "TEXT", "mandatory": false, "editable": true, "order": 4 },
        { "id": "attachments", "type": "FILE_UPLOAD", "mandatory": true, "editable": true, "order": 5 }
      ],
      "customFields": [
        {
          "id": "960369b2-...",
          "type": "NUMBER",
          "mandatory": true,
          "order": 0,
          "label": { "en_US": "Employee Code" }
        },
        {
          "id": "3c6cc6d9-...",
          "type": "DROPDOWN",
          "mandatory": true,
          "order": 1,
          "label": { "en_US": "Department" },
          "options": [
            { "option_id": "opt_1", "label": { "en_US": "IT" } },
            { "option_id": "opt_2", "label": { "en_US": "HR" } },
            { "option_id": "opt_3", "label": { "en_US": "FIN" } }
          ]
        }
      ]
    }
  }
}

Kernfeldreferenz

Benutzerdefinierte Felder werden vom Administrator definiert und in customFields[] zurückgegeben. Ihre IDs, Typen, obligatorischen Markierungen, Beschriftungen und Dropdown-Optionen variieren je nach Kontokonfiguration.

Einreichungen auflisten

GET /primeapi/v2/externalLearnings

Gibt eine paginierte Liste der eigenen Übertragungen des authentifizierten Teilnehmers zurück, sortiert nach modifiedAt absteigend (zuletzt geändert zuerst).

Abfrageparameter

Antwort 200 OK

{
  "links": {
    "next": "/primeapi/v2/externalLearnings?page[offset]=10&page[limit]=10"
  },
  "data": [
    { "id": "1001", "type": "externalLearning", "attributes": { "status": "PENDING", ... } },
    { "id": "1002", "type": "externalLearning", "attributes": { "status": "APPROVED", ... } }
  ]
}

Einreichen abrufen

GET /primeapi/v2/externalLearnings/{id}

Gibt den vollständigen Datensatz für eine einzelne Übermittlung zurück, die dem authentifizierten Teilnehmer gehört.

**Antwort 200 OK

{
  "data": {
    "id": "1001",
    "type": "externalLearning",
    "attributes": {
      "submissionUrl": "https://<cdn-url>/cert.pdf",
      "title": "Java Fundamentals Certification",
      "status": "PENDING",
      "creationSource": "LEARNER",
      "createdAt": "2026-04-14T08:30:00.000Z",
      "modifiedAt": "2026-04-16T11:45:00.000Z",
      "fields": [ "...resolved against live settings..." ]
    },
    "relationships": {
      "reviewerUser": { "data": null }
    }
  }
}

Einreichung erstellen

POST /primeapi/v2/externalLearnings

Erstellt eine neue externe Lernoberfläche im Status “AUSSTEHEND”. Alle in den Kontoeinstellungen definierten Pflichtfelder müssen einbezogen werden. Nach einer erfolgreichen POST erhält der Manager des Teilnehmers eine plattforminterne Benachrichtigung, um die Einreichung zu überprüfen.

Datei-Upload

Das Feld “Anlagen” wird getrennt von den anderen Feldern behandelt. Fügen Sie es nicht in die Felder “[]” ein. Stattdessen:

​1. Rufen Sie eine vorsignierte S3-Upload-URL vom ALM-Datei-Upload-Endpunkt ab.

​2. Laden Sie die Datei auf diese URL hoch.

​3. Übergeben Sie die resultierende URL als das übergeordnete submissionUrl-Attribut in Ihrer POST-Anforderung.

Anforderungstext

{
  "data": {
    "type": "externalLearning",
    "attributes": {
      "submissionUrl": "<pre-signed-upload-url>",
      "fields": [
        { "id": "title", "type": "TEXT", "value": "Java Fundamentals Certification" },
        { "id": "description_notes", "type": "TEXT", "value": "Completed via online course platform." },
        { "id": "date", "type": "TIMESTAMP", "value": { "start_date": "2026-05-01T00:00:00.000Z", "end_date": "2026-05-15T00:00:00.000Z" } },
        { "id": "score", "type": "NUMBER", "value": { "achieved_score": 88, "max_score": 100 } },
        { "id": "duration", "type": "TEXT", "value": "40 hours" },
        { "id": "960369b2-...", "type": "NUMBER", "value": "1225" },
        { "id": "3c6cc6d9-...", "type": "DROPDOWN", "value": "opt_3" }
      ]
    }
  }
}

Feldwert-Formen

POST der Validierungsregeln

Einreichung aktualisieren

PUT /primeapi/v2/externalLearnings/{id}

Aktualisiert eine vorhandene ausstehende Übermittlung. Nur ausstehende Einreichungen können aktualisiert werden. Wenn Sie versuchen, eine APPROVED- oder REJECTED-Übermittlung PUT, wird der Fehler 409 zurückgegeben.

Dieser Endpunkt verwendet die Semantik für die vollständige Ersetzung. Geben Sie in jeder PUT-Anforderung das vollständige Feld “[]” an, nicht nur die Felder, die Sie ändern. Aus dem Array ausgelassene Felder werden gelöscht.

Felder, die der Teilnehmer aktualisieren kann

Anforderungstext

{
  "data": {
    "type": "externalLearning",
    "attributes": {
      "submissionUrl": "<cdn-url>/cert-v2.pdf",
      "fields": [
        { "id": "title", "type": "TEXT", "value": "Java Fundamentals — Updated" },
        { "id": "description_notes", "type": "TEXT", "value": "Updated notes." },
        { "id": "date", "type": "TIMESTAMP", "value": { "start_date": null, "end_date": null } },
        { "id": "score", "type": "NUMBER", "value": { "achieved_score": 92, "max_score": 100 } },
        { "id": "duration", "type": "TEXT", "value": "42 hours" },
        { "id": "960369b2-...", "type": "NUMBER", "value": "1227" },
        { "id": "3c6cc6d9-...", "type": "DROPDOWN", "value": "opt_2" }
      ]
    }
  }
}

API für die lernerrelevante Zertifizierungs-ID und die Stammzertifizierungs-ID in LT

Wenn eine wiederkehrende Zertifizierung verlängert wird, erstellt Adobe Learning Manager eine neue Version der Zertifizierung und registriert automatisch aktive Teilnehmer dafür. Wenn Ihre Integration Zertifizierungsdaten direkt abfragt, anstatt sich auf das Adobe Learning Manager-Lernerlebnis zu verlassen, können Sie mit dieser API jederzeit genau bestimmen, welche Version einer wiederkehrenden Zertifizierung für einen bestimmten Teilnehmer relevant ist.

Zweck der API

Wiederkehrende Zertifizierungen generieren bei jeder Verlängerung eine neue Zertifizierungs-ID. Im nativen Adobe Learning Manager-Lernerlebnis wird nur die Version angezeigt, die für jeden Teilnehmer relevant ist. Ältere Versionen werden automatisch ausgeblendet, wenn ein Teilnehmer zu einer neueren Version wechselt.

Wenn Ihre Integration Zertifizierungsdaten unabhängig abruft, um z. B. Zertifizierungsinformationen in einem externen Portal anzuzeigen, wird diese Filterung möglicherweise nicht automatisch angewendet. Ohne diese Möglichkeit könnte ein Teilnehmer jede historische Version einer wiederkehrenden Zertifizierung sehen, einschließlich derjenigen, die für ihn nicht mehr relevant sind, ohne Angabe, auf welche er reagieren sollte.

Diese Lücke wurde mit dieser API geschlossen. Aufgrund der Stammzertifizierungs-ID gibt es die spezifische Zertifizierungsversion zurück, die für einen bestimmten Teilnehmer gilt, wobei dessen Registrierungsverlauf und etwaige Wiederholungen berücksichtigt werden.

Wiederkehrende Zertifizierungen

Wenn eine Zertifizierung so konfiguriert ist, dass sie wiederholt wird, erstellt jede Verlängerung eine neue Zertifizierungsversion mit einer eigenen eindeutigen ID. Alle Versionen werden auf eine einzige Stammzertifizierungs-ID zurückverfolgt, auf die ID der ursprünglichen Zertifizierung, als diese erstmalig erstellt wurde.

Eine Zertifizierung, die jeden Monat wiederholt wird, kann beispielsweise zu einer Abfolge von Versionen im Zeitverlauf führen, bei denen jede neue Version automatisch generiert wird, wenn das Wiederholungsintervall erreicht wird. Teilnehmer, die aktiv registriert sind, wenn ein Wiederholungsfall auftritt, werden automatisch für die neue Version registriert.

Da jede Version eine eigene ID hat, hängt die relevante Version eines Teilnehmers von seiner individuellen Registrierungszeitleiste ab:

Ermitteln der entsprechenden Zertifizierungsversion

Verwenden Sie die API für die Zertifizierungsversion, um zu ermitteln, welche Version einer wiederkehrenden Zertifizierung für einen bestimmten Teilnehmer relevant ist.

Geben Sie die Stammzertifizierungs-ID als Eingabe an. Die API wertet den Registrierungsverlauf des Teilnehmers aus und gibt die entsprechende Version basierend auf den folgenden Regeln zurück:

Dies bedeutet, dass zwei Teilnehmer, die gleichzeitig dieselbe Stammzertifizierungs-ID abfragen, je nach individuellem Registrierungsverlauf jedes Teilnehmers unterschiedliche Ergebnisse erhalten.

Beispiel

Nehmen wir an, es handelt sich um eine Zertifizierung, die monatlich wiederholt wird und bei der im Laufe der Zeit aufgrund aufeinander folgender Wiederholungen vier Versionen erstellt wurden:

Dadurch kann die Integration einen Teilnehmer immer zur für ihn relevanten Zertifizierungsversion leiten, anstatt jede ältere Version anzuzeigen oder zu erraten, welche zutreffend ist.

API-Referenz

Erhalten Sie die entsprechende Zertifizierung für eine Stammzertifizierung

GET /primeapi/v2/learningObjects/{loId}/applicableCertification

Löst die Zertifizierungsversion auf, die für den aktuellen Teilnehmer gilt, wenn die ID einer Stammzertifizierung angegeben wird. Bei Teilnehmern, für die eine Registrierung vorliegt, wird hiermit die Version zurückgegeben, für die sie derzeit registriert sind. Für Teilnehmer, die nicht registriert sind, gibt dies die neueste aktive Version zurück.

Hinweis: Diese API gibt Versionsinformationen für jeweils einen einzelnen Teilnehmer zurück. Es wird keine Liste aller Versionen einer Zertifizierung zurückgegeben.

Pfadparameter

Abfrageparameter

Beispielanforderung

GET /primeapi/v2/learningObjects/certification%3A167658/applicableCertification?include=subLOs
Accept: application/vnd.api+json
Authorization: oauth <access-token>

curl -X GET --header 'Accept: application/vnd.api+json' \
--header 'Authorization: oauth <access-token>' \
'https://<host>/primeapi/v2/learningObjects/certification%3A167658/applicableCertification?include=subLOs'

Hinweis: Der loId-Wert muss URL-codiert sein. Der Doppelpunkt in einer Zertifizierungs-ID wie certification:167658 ist als %3A codiert.

Beispielantwort 200 OK

Die Antwort verwendet dieselbe Struktur wie eine standardmäßige Lernobjektreaktion und gibt die aufgelöste Zertifizierung zurück.

Wichtig: Das ID-Feld in der Antwort ist die ID der aufgelösten-Zertifizierung, die spezifische Version, die für diesen Teilnehmer gilt. Sie unterscheidet sich in der Regel von der Stammzertifizierungs-ID, die Sie als loId übergeben haben, da der gesamte Zweck dieser API darin besteht, eine Stammzertifizierungs-ID in die richtige aktuelle Version zu übersetzen.

{
  "data": {
    "id": "string",
    "type": "string",
    "attributes": {
      "authorNames": [
        "string"
      ],
      "bannerUrl": "string",
      "catalogs": [
        ...
      ]
    }
  }
}

Antwortcodes

Beispielfehlerantwort

{
  "meta": {
    "error": "string",
    "detail": "string"
  }
}

Hinweis: Diese API löst die Version für einen Teilnehmer pro Aufruf auf. Es wird keine Liste aller Versionen zurückgegeben, die für eine Stammzertifizierung vorhanden sind.

Wichtige Punkte

Hinweis: Ein Äquivalent dieser API, das für Administratoren vorgesehen ist, ist derzeit nicht verfügbar und wird für eine zukünftige Version bewertet.

Diese API in Ihrer Integration verwenden

Ein häufiger Anwendungsfall ist eine externe Seite oder ein Portal, auf der bzw. in dem Zertifizierungen aufgeführt sind, auf die ein Teilnehmer zugreifen kann. Anstatt eine direkte Verknüpfung mit einer bestimmten Zertifizierungs-ID herzustellen, die nach einer Wiederholung möglicherweise veraltet ist. Verwenden Sie die Stammzertifizierungs-ID und lösen Sie die richtige Version auf, wenn der Teilnehmer sie auswählt.

​1. Speichern oder verweisen Sie Zertifizierungen in Ihrer Integration mit der Stammzertifizierungs-ID, der ID der Zertifizierung, wie sie zuerst erstellt wurde, bevor es erneut vorkommt.

​2. Wenn ein Teilnehmer eine Zertifizierung auswählt, die er anzeigen oder bearbeiten möchte, rufen Sie GET /primeapi/v2/learningObjects/{loId}/applicableCertification auf, wobei Sie die Stammzertifizierungs-ID als loId übergeben.

​3. Verwenden Sie die in der Antwort zurückgegebene Zertifizierungsversion, um den Teilnehmer zum richtigen Ziel zu leiten, unabhängig davon, ob es sich um eine Registrierungsaktion oder eine Ansicht seines aktuellen Fortschritts handelt.

Dadurch wird sichergestellt, dass Teilnehmer immer auf der Version der Zertifizierung landen, die ihrer tatsächlichen Registrierung und ihrem Fortschritt entspricht, auch wenn die Zertifizierung im Laufe der Zeit immer wieder vorkommt und neue Versionen generiert.

Berichte: Stammtrainings-ID im Teilnehmertranskript

Die Spalte Stammtrainings-ID ist standardmäßig im Teilnehmertranskript für alle Konten verfügbar.

Hinweis: Bei sehr großen Konten mit einem hohen Volumen von Zertifizierungen werden die Stammtrainings-ID-Werte im Teilnehmertranskript stapelweise aufgelöst. Dies ändert die Genauigkeit der Daten nicht, aber die Erstellung sehr großer Transkripte kann länger dauern.

In dieser Spalte können Sie den vollständigen Verlauf eines Teilnehmers in jeder Version einer wiederkehrenden Zertifizierung gruppieren und Bericht erstatten, anstatt jede Wiederholung als unabhängigen, unabhängigen Datensatz zu behandeln. Jede Wiederholung wird weiterhin als eigene Zeile im Teilnehmertranskript angezeigt. Die Spalte “Stammtrainings-ID” gibt einfach an, welche Zeilen zu derselben zugrunde liegenden Zertifizierung gehören.

Hinweis: Verwenden Sie die Spalte “Ursprüngliche Schulungs-ID”, wenn Sie den vollständigen Teilnahmeverlauf eines Teilnehmers über eine wiederkehrende Zertifizierung nachverfolgen müssen.