API non connectées

Pour en savoir plus sur les API Adobe Learning Manager, qui fournissent des données pour l’expérience sans affichage ou non connectée, consultez cet article.
API Search publique

API Search publique

Filtrer les données à l’aide de Public ES

L’API Public Search vous permet d’obtenir les données de filtre qui peuvent être utilisées avec l’API de recherche de base pour filtrer les cours. Cette API fournit tous les filtres pouvant être utilisés dans l’API de recherche.

Exemple de curl

Utilisez la méthode GET pour effectuer la requête suivante. Remplacez <Base_URL> par votre URL de base dans la commande curl ci-dessous. </Base_URL> Vous trouverez le <Base_URL> sur la page du connecteur d’accès aux données de formation.</Base_URL>

curl --location '<Base_URL>/filterableData'

Exemple de réponse

{
    "terms": {
        "loSkillLevels": [
            "1"
        ],
        "catalogNames": [
            "Default Catalog"
        ],
"catalogLabelIds": [
            "0000_1111"
        ],
        "loType": [
            "course"
        ],
        "availability": [
            "waitlistAvailable",
            "seatAvailable"
        ],
        "loSkillNames": [
            "General"
        ],
        "tags": [
            "course_tag"
        ],
        "authors": [
            "author_1"
]
    },
    "range": {
        "duration": [
            "0"
        ],
        "dateCreated": [
            "2024-06-13T04:32:17.000Z"
        ],
        "price": [
            "0.0"
        ],
        "sessionEndTime": [
            "2024-06-18T20:30:00.000Z"
        ],
        "averageRating": [
            "0.0"
        ],
        "sessionStartTime": [
            "2024-06-18T19:30:00.000Z"
        ],
        "publishDate": [
            "2024-06-13T04:32:51.000Z"
        ],
        "ratingsCount": [
            "0"
        ]
    },
    "term": {}
}

Options de filtre

Options
Description
loSkillLevels
Le niveau de compétence requis pour s’inscrire au cours.
catalogNames
Liste des noms de catalogues disponibles.
loType
Types d’objets d’apprentissage disponibles.
availability
La disponibilité des places et la disponibilité de la liste d’attente.
loSkillNames
Noms des compétences ajoutées aux objets d’apprentissage.
tags
Balises associées aux objets d’apprentissage.
authors
Nom de l’auteur des objets d’apprentissage
duration
Durée des objets d’apprentissage.
dateCreated
Date à laquelle l’objet d’apprentissage a été créé.
sessionEndTime
Heure à laquelle la session s’est terminée.
averageRating
Le nombre moyen d’étoiles des objets d’apprentissage.
sessionStartTime
Heure à laquelle la session a commencé.
publishDate
Date de publication de l’objet d’apprentissage.
ratingsCount
Nombre de notes pour l’objet d’apprentissage.

Search API

L’API Search publique vous permet d’obtenir des données de recherche de base à l’aide des données fournies.

Exemple de Curl

Utilisez la méthode POST pour effectuer la requête suivante. Remplacez <Base_URL> par votre URL de base dans la commande curl ci-dessous. </Base_URL> Vous trouverez le <Base_URL> sur la page du connecteur d’accès aux données de formation.</Base_URL>

curl --location '<Base_URL>/search?size=1000' \
--header 'content-type: application/json'

--data '{
   "query": "",

    "sort": {
        "name": "publishDate",
        "order": "desc"
    },
    "lang": [
        "en-US"
    ],
    "filters": {
        "terms": {
            "loType": [
                "course",
                "learningProgram",
                "certification"
            ],
            "availability": [
                "seatAvailable",
                "waitlistAvailable"
            ]
        },
        "term": {
            "enrollmentDeadlinePassed": "true"
        },
        "range": {
                "dateCreated": [
                    {
                        "gte": "2024-05-02T02:48:51.000Z"
                    }
                ],
            "sessionStartTime": [
                {
                   "gte": "2024-06-18T19:30:00.000Z"
                }
            ],
            "sessionEndTime": [
                {
                   "lte": "2024-06-20T09:30:00.000Z"
                }
            ]
        }
    }
}'

Exemple de réponse de l’appel API

{
    "results": [
        {
            "loId": "course:11332313",
            "loType": "course",
            "tags": [
                "course_tag"
            ],
            "authors": [
                "author1",
                "author2"
            ],
            "status": "Published",
            "duration": 0,
            "publishDate": "2024-06-13T04:32:51.000Z",
            "dateCreated": "2024-06-13T04:32:17.000Z",
            "name": "vc coursse to check ",
            "averageRating": 0.0,
            "ratingsCount": 0,
            "loSkillNames": [
                "General"
            ],
            "loSkillLevels": [
                "1"
            ],
            "loInstances": [
                {
                    "id": "14346696",
                    "name": "Default Instance",
                    "status": "Active",
                    "price": 0.0
                }
            ],
            "catalogInfo": [
                {
                    "id": "37779",
                    "name": "Default Catalog"
                }
            ]
        }
    ],
    "request": {
        "query": "",
        "filters": {
            "terms": {
                "loType": [
                    "course",
                    "learningProgram",
                    "certification"
                ],
                "loSkillNames": [
                    "General"
                ],
                "deliveryType": [],
                "availability": [
                    "seatAvailable",
                    "waitlistAvailable"
                ]
            },
            "term": {
                "enrollmentDeadlinePassed": "true"
            },
            "range": {
                "dateCreated": [
                    {
                        "gte": "2024-05-02T02:48:51.000Z"
                    }
                ],
                "sessionStartTime": [
                    {
                        "gte": "2024-06-18T19:30:00.000Z"
                    }
                ],
                "sessionEndTime": [
                    {
                        "lte": "2024-06-20T09:30:00.000Z"
                    }
                ]
            }
        },
        "sort": {
            "name": "publishDate",
            "order": "desc"
        },
        "lang": [
            "en-US"
        ]
    },
    "self": "<Base_URL>/search?page=0&size=1000",
    "count": 1
}

Options de tri sur l’API Search

Vous pouvez sélectionner les options de tri suivantes à appliquer aux résultats.

Options
Description
duration
Durée de l’objet d’apprentissage.
publishDate
Date de publication de l’objet d’apprentissage.
dateCreated
Date à laquelle l’objet d’apprentissage a été créé.
name_en
Nom de l’objet d’apprentissage.
averageRating
Note moyenne par étoiles fournie par les apprenants.
ratingsCount
Nombre de notes pour l’objet d’apprentissage.
relevance(default)
Les données pertinentes sont basées sur les mots-clés de recherche.

Obtention de données d’objet d’apprentissage à l’aide de l’API de recherche publique

L’API Public ES Learning Object vous permet d’obtenir la liste des types et des ID d’objets d’apprentissage disponibles sur l’interface sans affichage.

Exemple de curl

Utilisez la méthode GET pour effectuer la requête suivante. Remplacez <Base_URL> par votre URL de base dans la commande curl ci-dessous. </Base_URL> Vous trouverez le <Base_URL> sur la page du connecteur d’accès aux données de formation.</Base_URL>

curl --location '<Base_URL>/learningObjectIds'

Exemple de réponse pour l’appel d’API

{
    "loIds": [
        "course:1132800",
"certification:126009",
"learningProgram:104433"
    ]
}

API de résumé du cours

L’API de résumé de cours vous permet de récupérer des informations détaillées sur un cours spécifique.

Exemple de curl

Utilisez la méthode GET pour effectuer la requête suivante. Remplacez <Base_URL> par votre URL de base dans la commande curl ci-dessous. </Base_URL> Vous trouverez le <Base_URL> sur la page du connecteur d’accès aux données de formation. </Base_URL> Remplacez cet <Course_ID> espace par l’ID de cours spécifique.</Course_ID>

curl --location '<Base_URL>/loSummary?loId=course%3A<Course_ID>'

Exemple de réponse de l’appel API

{
    "results": [
        {
            "instanceId": "14336686",
            "courseId": "11312313",
            "accountId": "44355",
            "seatConsumed": 1,
            "seatLimit": 1,
            "waitlistLimit":1,
            "waitlistCount": 1,
            "seatAvailable": false,
            "waitlistAvailable": false
        }
    ],
    "count": 1
}
NOTE
Si un cours comporte plusieurs instances, vous obtiendrez des détails pour toutes les instances.

API JSON CDN pour les détails du cours

L’API CDN JSON vous permet de récupérer les informations complètes sur un cours spécifique.

Exemple de curl pour le cours

Utilisez la méthode GET pour effectuer la requête suivante. Remplacez <CDN_path> par votre URL de base dans la commande curl ci-dessous. </CDN_path> Vous trouverez le <CDN_path> sur la page du connecteur d’accès aux données de formation. </CDN_path> Remplacez cet <Course_ID> espace par l’ID de cours spécifique.</Course_ID>

curl --location '<CDN_path_URL>/course/<Course_ID>.json'

Exemple de curl pour le cursus de formation et la certification

curl --location '<CDN_path_URL>/learningProgram/<LearningProgram_ID>.json'
curl --location '<CDN_path_URL>/ certification /<Certification_ID>.json'

Exemple de réponse de l’appel API

{
    "data": {
        "id": "course:11342313",
        "type": "learningObject",
        "attributes": {
            "authorNames": [
                "author1",
                "author2"
            ],
            "dateCreated": "2024-06-13T04:32:17.000Z",
            "datePublished": "2024-06-13T04:32:51.000Z",
            "dateUpdated": "2024-06-13T04:32:51.000Z",
            "duration": 0,
            "effectiveModifiedDate": "2024-06-13T04:32:51.000Z",
            "effectivenessIndex": 0,
            "enrollmentType": "Self Enroll",
            "hasOptionalLoResources": false,
            "hasPreview": false,
            "isExternal": false,
            "isMqaEnabled": false,
            "isPrerequisiteEnforced": false,
            "isSubLoOrderEnforced": false,
            "loResourceCompletionCount": 1,
            "loType": "course",
            "moduleResetEnabled": false,
            "state": "Published",
            "tags": [
                "course_tag"
            ],
            "unenrollmentAllowed": true,
            "localizedMetadata": [
                {
                    "description": "",
                    "locale": "en-US",
                    "name": "vc coursse to check "
                }
            ],
            "rating": {
                "averageRating": 0,
                "ratingsCount": 0
            }
        },
        "relationships": {
            "authors": {
                "data": [
                    {
                        "id": "13138897",
                        "type": "user"
                    }
                ]
            },
            "instances": {
                "data": [
                    {
                        "id": "course:11332313_14336696",
                        "type": "learningObjectInstance"
                    }
                ]
            },
            "skills": {
                "data": [
                    {
                        "id": "course:11332313_237719",
                        "type": "learningObjectSkill"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "id": "237719",
            "type": "skill",
            "attributes": {
                "name": "General",
                "state": "Active"
            },
            "relationships": {
                "levels": {
                    "data": [
                        {
                            "id": "237719_1",
                            "type": "skillLevel"
                        }
                    ]
                }
            }
        },
        {
            "id": "course:11312313",
            "type": "learningObject",
            "attributes": {
                "authorNames": [
                    "m 41",
                    "rae"
                ],
                "dateCreated": "2024-06-13T04:32:17.000Z",
                "datePublished": "2024-06-13T04:32:51.000Z",
                "dateUpdated": "2024-06-13T04:32:51.000Z",
                "duration": 0,
                "effectiveModifiedDate": "2024-06-13T04:32:51.000Z",
                "effectivenessIndex": 0,
                "enrollmentType": "Self Enroll",
                "hasOptionalLoResources": false,
                "hasPreview": false,
                "isExternal": false,
                "isMqaEnabled": false,
                "isPrerequisiteEnforced": false,
                "isSubLoOrderEnforced": false,
                "loResourceCompletionCount": 1,
                "loType": "course",
                "moduleResetEnabled": false,
                "state": "Published",
                "tags": [
                    "course_tag"
                ],
                "unenrollmentAllowed": true,
                "localizedMetadata": [
                    {
                        "description": "",
                        "locale": "en-US",
                        "name": "course name "
                    }
                ],
                "rating": {
                    "averageRating": 0,
                    "ratingsCount": 0
                }
            },
            "relationships": {
                "authors": {
                    "data": [
                        {
                            "id": "13128897",
                            "type": "user"
                        }
                    ]
                },
                "instances": {
                    "data": [
                        {
                            "id": "course:11312313_14336696",
                            "type": "learningObjectInstance"
                        }
                    ]
                },
                "skills": {
                    "data": [
                        {
                            "id": "course:11312313_237719",
                            "type": "learningObjectSkill"
                        }
                    ]
                }
            }
        },
        {
            "id": "course:11312313_14336696_12034506_0",
            "type": "learningObjectResource",
            "attributes": {
                "externalReporting": false,
                "isExpiredSubmission": false,
                "loResourceType": "Content",
                "multipleAttemptEnabled": false,
                "previewEnabled": false,
                "resourceType": "Virtual Classroom",
                "submissionEnabled": false,
                "localizedMetadata": [
                    {
                        "description": "",
                        "locale": "en-US",
                        "name": "vc session"
                    }
                ]
            },
            "relationships": {
                "learningObject": {
                    "data": {
                        "id": "course:11312313",
                        "type": "learningObject"
                    }
                },
                "resources": {
                    "data": [
                        {
                            "id": "course:11312313_14336696_12034506_0_resource",
                            "type": "resource"
                        }
                    ]
                }
            }
        },
        {
            "id": "course:11312313_237719",
            "type": "learningObjectSkill",
            "attributes": {
                "credits": 1,
                "learningObjectId": "course:11312313"
            },
            "relationships": {
                "skillLevel": {
                    "data": {
                        "id": "237719_1",
                        "type": "skillLevel"
                    }
                }
            }
        },
        {
            "id": "13128897",
            "type": "user",
            "attributes": {
                "avatarUrl": "https://abccontents.adobe.com/public/images/default_user_avatar.svg",
                "binUserId": "1f8c01aa-7f58-42e9-bc40-11537eb6498d",
                "email": "manjusha+41re@adobetest.com",
                "enrollOnClick": false,
                "gamificationEnabled": true,
                "lastLoginDate": "2024-06-13T04:23:45.000Z",
                "name": "m 41",
                "pointsEarned": 0,
                "pointsRedeemed": 0,
                "preferredResolution": "AUTO",
                "profile": "admin",
                "roles": [
                    "Learner",
                    "Admin",
                    "Author",
                    "Instructor",
                    "Integration Admin"
                ],
                "state": "ACTIVE",
                "userType": "Internal"
            },
            "relationships": {
                "account": {
                    "data": {
                        "id": "44355",
                        "type": "account"
                    }
                }
            }
        },
        {
            "id": "course:11312313_14336696_12034506_0_resource",
            "type": "resource",
            "attributes": {
                "avatarUrls": [
                    "https://abccontents.adobe.com/public/images/default_user_avatar.svg"
                ],
                "completionDeadline": "2024-06-18T20:30:00.000Z",
                "contentType": "Virtual Classroom",
                "dateStart": "2024-06-18T19:30:00.000Z",
                "desiredDuration": 3600,
                "hasQuiz": false,
                "hasToc": false,
                "instructorNames": [
                    "instructor1"
                ],
                "isDefault": true,
                "locale": "en-US",
                "location": "http://google.com",
                "name": "vc session",
                "onlyQuiz": false,
                "reportingType": "NONE"
            }
        },
        {
            "id": "course:11312313_14336696",
            "type": "learningObjectInstance",
            "attributes": {
                "dateCreated": "2024-06-13T04:32:18.000Z",
                "isDefault": true,
                "isFlexible": false,
                "state": "Active",
                "localizedMetadata": [
                    {
                        "locale": "en-US",
                        "name": "Default Instance"
                    }
                ],
                "seatConsumed": 0,
                "waitlistCount": 0
            },
            "relationships": {
                "learningObject": {
                    "data": {
                        "id": "course:11312313",
                        "type": "learningObject"
                    }
                },
                "loResources": {
                    "data": [
                        {
                            "id": "course:11312313_14336696_12034506_0",
                            "type": "learningObjectResource"
                        }
                    ]
                }
            }
        },
        {
            "id": "237719_1",
            "type": "skillLevel",
            "attributes": {
                "level": "1",
                "maxCredits": 1,
                "name": "Level 1"
            },
            "relationships": {
                "skill": {
                    "data": {
                        "id": "237719",
                        "type": "skill"
                    }
                }
            }
        }
    ]
}
recommendation-more-help
d5e5961a-141b-4c77-820e-8453ddef913d