Modifiche alle API nella versione di settembre 2026 di Adobe Learning Manager
API per la verifica dell’accesso al catalogo per gli oggetti di apprendimento
Determina se l’Allievo corrente ha accesso diretto al catalogo a uno o più oggetti di apprendimento, indipendentemente dal fatto che abbia raggiunto tale contenuto tramite un percorso di apprendimento o una certificazione.
Scopo dell’API
Quando un Allievo apre un percorso di apprendimento o una certificazione, può sfogliare i singoli corsi al suo interno, anche se un corso specifico non gli viene assegnato direttamente tramite un catalogo. Questo supporta l’individuazione dei contenuti: gli Allievi possono esplorare il contenuto di un percorso di apprendimento prima di decidere se proseguirlo o meno.
Tuttavia, la possibilità di visualizzare un corso in questo modo non dovrebbe implicare automaticamente che l’Allievo possa iscriverlo. L’iscrizione deve dipendere dal fatto che l’Allievo abbia o meno accesso diretto al catalogo per il corso specifico, non solo accesso indiretto tramite un percorso di apprendimento che lo contiene.
Questa API consente di verificare, per un determinato Allievo, se uno o più oggetti di apprendimento sono direttamente accessibili tramite un catalogo loro assegnato. Utilizza il risultato per controllare l’interfaccia utente relativa all’iscrizione, ad esempio, mostrando un’opzione Iscrizione solo quando l’accesso diretto al catalogo è confermato, mantenendo la pagina del corso visualizzabile in entrambi i casi.
Endpoint
GET /primeapi/v2/learningObjects/isMemberOfVisibleCatalogs
Parametri di query
Richiesta di esempio
GET /primeapi/v2/learningObjects/isMemberOfVisibleCatalogs?ids=course%3A2400159%2Ccourse%3A2400160%2Ccourse%3A2400161%2Ccourse%3A2400162
Accept: application/vnd.api+json
Authorization: oauth <access-token>
Esempio di risposta - 200 OK
{
"course:2400162": false,
"course:2400161": false,
"course:2400160": true,
"course:2400159": true
}
Codici di risposta
Esempio di risposta di errore
{
"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"
}
}
Utilizza questa API nell’integrazione
Un caso d’uso comune è una pagina del corso che un Allievo raggiunge navigando da un percorso di apprendimento. Desideri che la pagina del corso rimanga accessibile per l’individuazione, mostrando l’azione Iscrizione solo se l’Allievo ha accesso diretto al catalogo per quel corso.
- Quando viene caricata la pagina del corso, chiama questo endpoint con l’ID dell’oggetto di apprendimento del corso.
- Se la risposta restituisce true per l’ID, visualizzare l’opzione Iscrizione.
- Se la risposta restituisce false, mantieni visibile la pagina del corso, il titolo, la descrizione e i dettagli del corso, ma nascondi l’opzione Iscrizione.
API dei processi per il report di prova di verifica dell’amministratore apiaudittrailreport
Scopo dell’API
Il report Audit trail dell’amministratore elenca le modifiche di configurazione apportate a un
Account Adobe Learning Manager. Ad esempio, modifiche a Nozioni di base, Integrazioni o
Impostazioni avanzate dell’account in un determinato intervallo di date. La generazione del report Audit trail richiede l’esecuzione di query e l’aggregazione dei record di modifica della configurazione nell’intervallo di date richiesto e nei tipi di impostazione. A seconda delle dimensioni dell’intervallo e del volume delle modifiche, questo valore può superare i limiti di tempo di una richiesta HTTP sincrona, con conseguente rischio di timeout del client o del gateway.
Per evitare ciò, il report viene generato in modo asincrono tramite l’API generica dei processi:
-
Crea un processo. L’amministratore invia una richiesta specificando il tipo di report, l’intervallo di date e i tipi di impostazione. L’API restituisce immediatamente un ID processo, senza attendere la compilazione del report.
-
Sondaggio del processo. L’amministratore recupera periodicamente il processo in base al suo ID per verificarne lo stato. Al termine del processo, la risposta contiene il risultato o un riferimento al risultato.
URL di base e convenzioni
/primeapi/v2application/vnd.api+json;charset=UTF-8 (JSON:API)x-acap-account che identifica l’account dell’amministratore chiamantestatus non è più QUEUED o IN_PROGRESSID
Il processo id restituito durante la creazione di un processo è una stringa opaca, ad esempio4593). Restituisci sempre il valore id esatto ricevuto dalla creazione
risposta durante il polling per lo stato. Non costruirlo o analizzarlo mai.
Ambiti di autenticazione
Ogni endpoint richiede un token OAuth con l’ambito seguente e
l’utente che effettua la chiamata deve avere il ruolo di amministratore dell’account:
admin:writecrea un processo di report (ROLE_ADMINrichiesto)admin:readha letto lo stato e il risultato di un processo (ROLE_ADMINrichiesto)
Le richieste effettuate da un chiamante che non detiene ROLE_ADMIN sull’account sono
rifiutato. Vedere Gestione errori
Endpoint
Creare un processo di report di audit trail
POST /primeapi/v2/jobs
Crea un processo asincrono che genera un report di traccia di revisione della modifica della configurazione
per l’intervallo di date e i tipi di impostazione specificati. La risposta viene restituita immediatamente
con una risorsa processo nello stato QUEUED. Il report stesso viene prodotto nel
sfondo.
Ambito: admin:write
jobTypegenerateConfigChangeAuditReport per questo reportpayload.fromDate2026-09-15T00:00:00.000+05:30payload.toDate2026-09-23T23:59:59.000+05:30payload.settingTypesBasics, Integrations e AdvancedCorpo della richiesta di esempio
{
"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"]
}
}
}
}
Risposta: 202 Created. Il corpo della risposta è la risorsa del processo nella relativa posizione iniziale
Stato QUEUED.
{
"data": {
"id": "4593",
"type": "job",
"attributes": {
"jobType": "generateConfigChangeAuditReport",
"status": "QUEUED",
"dateCreated": "2026-09-23T18:12:04.000+05:30"
}
}
}
fromDate/toDate che si estende su un intervallo di date molto ampio o cherichiede tutti i tipi di impostazione per un account con una lunga cronologia modifiche.
l’elaborazione richiede più tempo. Eseguire il polling dell'endpoint Ottieni stato processo anziché
presupponendo che il report sia pronto dopo un determinato ritardo.
Ottenere lo stato di un processo di report di audit trail
GET /primeapi/v2/jobs/{id}
Restituisce lo stato corrente di un processo creato in precedenza. Durante l’esecuzione del processo
ancora in esecuzione, attributes.status è QUEUED o IN_PROGRESS eattributes.result è assente. Al termine del processo, attributes.status èCOMPLETED, con il percorso del report in attributes.result, oppureFAILED, con dettagli errore in attributes.error.
Ambito: admin:read
idRisposta di esempio mentre il processo è ancora in esecuzione
{
"data": {
"id": "4593",
"type": "job",
"attributes": {
"jobType": "generateConfigChangeAuditReport",
"status": "IN_PROGRESS",
"dateCreated": "2026-09-23T18:12:04.000+05:30"
}
}
}
Risposta di esempio al completamento del processo
{
"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"
}
}
}
}
Schema risorsa
Attributi processo
idjobTypegenerateConfigChangeAuditReport per questo reportstatusQUEUED, IN_PROGRESS, COMPLETED o FAILEDdateCreateddateCompletedstatus: COMPLETED o FAILEDpayloadresultstatus è COMPLETED (incorporato - vedere di seguito)errorstatus è FAILEDPayload (incorporato, nella richiesta di creazione)
fromDatetoDatesettingTypesBasics, Integrations, AdvancedRisultato (incorporato, all’interno di un processo completato)
downloadUrlexpiresAtdownloadUrl smette di essere valido. Richiedere un nuovo controllo dello stato per ottenere un nuovo collegamento in seguitoGestione degli errori audit-trail-report-error-handling
I seguenti codici si applicano a questi endpoint:
BAD_REQUESTtoDate è precedente a fromDate, settingTypes è vuoto o contiene un valore non supportato o una data non valida ISO-8601 - crea solo endpointUNAUTHORIZED_ACCESSFORBIDDENROLE_ADMIN nell’accountOBJECT_DOESNT_EXISTEsempio di risposta di errore
{
"status": "BAD_REQUEST",
"title": "Bad request. Check url, params and headers",
"source": {
"info": "toDate must be on or after fromDate"
}
}
Utilizza questa API nell’integrazione
Un caso d’uso comune è un’azione “Scarica prova di verifica” rivolta all’amministratore nella
schermata delle impostazioni dell’account.
- Quando l’amministratore seleziona un intervallo di date e uno o più tipi di impostazione e
conferma, chiamare l’endpoint create-job con tali valori. - Archivia il processo restituito
ided esegui il polling dell’endpoint Ottieni stato processo in un
intervallo ragionevole (ad esempio, ogni pochi secondi). - Mentre
statusèQUEUEDoIN_PROGRESS, continua a visualizzare uno stato di avanzamento
nell’interfaccia utente. - Quando
statusdiventaCOMPLETED, utilizzareresult.downloadUrlper consentire a
l’amministratore scarica il report prima cheexpiresAtpassi. - Quando
statusdiventaFAILED, rivolgierrorall’amministratore e concedigli di
riprova.