Niet-aangemelde API's

In dit artikel vindt u meer informatie over de ADOBE Learning Manager-API's die gegevens bieden voor gebruikers zonder kop of zonder aanmelding.
Openbare zoek-API

Openbare zoek-API

Gegevens filteren met openbare elektronische elektronische gegevens (ES)

Met de Openbare zoek-API kunt u de filtergegevens ophalen die met de basiszoekfunctie kunnen worden gebruikt om de cursussen te filteren. Deze API biedt alle filters die in de zoek-API kunnen worden gebruikt.

Voorbeeld van krullen

Gebruik de methode GET om de volgende aanvraag te doen. Vervang <Base_URL> dit door de basis-URL in de onderstaande opdracht voor het krullen. </Base_URL> U vindt het <Base_URL> op de connectorpagina voor trainingsgegevenstoegang.</Base_URL>

curl --location '<Base_URL>/filterableData'

Voorbeeldreactie

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

Filteropties

Opties
Beschrijving
loSkillLevels
het vereiste vaardigheidsniveau om je in te schrijven voor de cursus.
catalogNames
Lijst met beschikbare catalogusnamen.
loType
Typen beschikbare leerobjecten.
availability
De beschikbare plaatsen en de beschikbaarheid op de wachtlijst.
loSkillNames
De namen van de vaardigheidsnamen die aan de leerobjecten zijn toegevoegd.
tags
De tags die zijn gekoppeld aan de leerobjecten.
authors
De naam van de auteur van de leerobjecten
duration
De duur van de leerobjecten.
dateCreated
De datum waarop het leerobject is gemaakt.
sessionEndTime
De tijd dat de sessie is beƫindigd.
averageRating
De gemiddelde sterrenclassificatie van de leerobjecten.
sessionStartTime
Het tijdstip waarop de sessie begon.
publishDate
De gepubliceerde datum van het leerobject.
ratingsCount
Het aantal waarderingen telt mee voor het leerobject.

Zoeken in API

Met de openbare zoek-API kunt u aan de hand van de verstrekte gegevens basiszoekgegevens ophalen.

Voorbeeld van krullen

Gebruik de methode POST om de volgende aanvraag te doen. Vervang <Base_URL> dit door de basis-URL in de onderstaande opdracht voor het krullen. </Base_URL> U vindt het <Base_URL> op de connectorpagina voor trainingsgegevenstoegang.</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"
                }
            ]
        }
    }
}'

Voorbeeld van de REACTIE van de API-aanroep

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

Sorteeropties op de zoek-API

U kunt de volgende sorteeropties selecteren om op de resultaten toe te passen.

Opties
Beschrijving
duration
De duur van het leerobject.
publishDate
De gepubliceerde datum van het leerobject.
dateCreated
De datum waarop het leerobject is gemaakt.
name_en
De naam van het leerobject.
averageRating
Gemiddelde sterrenclassificatie van de leerlingen.
ratingsCount
Het aantal waarderingen telt mee voor het leerobject.
relevance(default)
De relevante gegevens zijn gebaseerd op de trefwoorden.

Leerobjectgegevens ophalen met de openbare zoek-API

Met de Openbare ES-leerobject-API kunt u een lijst weergeven met typen en id's van leerobjecten die beschikbaar zijn in de headless-interface.

Voorbeeld van krullen

Gebruik de methode GET om de volgende aanvraag te doen. Vervang <Base_URL> dit door de basis-URL in de onderstaande opdracht voor het krullen. </Base_URL> U vindt het <Base_URL> op de connectorpagina voor trainingsgegevenstoegang.</Base_URL>

curl --location '<Base_URL>/learningObjectIds'

Voorbeeld van reactie voor de API-aanroep

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

Cursusoverzicht API

Met de API voor het cursusoverzicht kunt u gedetailleerde informatie over een specifieke cursus ophalen.

Voorbeeld van krullen

Gebruik de methode GET om de volgende aanvraag te doen. Vervang <Base_URL> dit door de basis-URL in de onderstaande opdracht voor het krullen. </Base_URL> U vindt het <Base_URL> op de connectorpagina voor trainingsgegevenstoegang. </Base_URL> Vervang <Course_ID> deze door de specifieke cursus-id.</Course_ID>

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

Voorbeeld van de REACTIE van de API-aanroep

{
    "results": [
        {
            "instanceId": "14336686",
            "courseId": "11312313",
            "accountId": "44355",
            "seatConsumed": 1,
            "seatLimit": 1,
            "waitlistLimit":1,
            "waitlistCount": 1,
            "seatAvailable": false,
            "waitlistAvailable": false
        }
    ],
    "count": 1
}
NOTE
Als een cursus meerdere instanties heeft, krijg je de details voor alle instanties.

CDN JSON-API voor cursusdetails

Met de CDN JSON-API kunt u de volledige cursusinformatie over een specifieke cursus ophalen.

Monster krullen voor natuurlijk

Gebruik de methode GET om de volgende aanvraag te doen. Vervang <CDN_path> dit door de basis-URL in de onderstaande opdracht voor het krullen. </CDN_path> U vindt het <CDN_path> op de connectorpagina voor trainingsgegevenstoegang. </CDN_path> Vervang <Course_ID> deze door de specifieke cursus-id.</Course_ID>

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

Voorbeeldkrul voor leerpad en certificering

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

Voorbeeld van de REACTIE van de API-aanroep

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