Rozhranie API pre Microsoft Learn Catalog

  • Článok
  • 20 min na prečítanie

Rozhranie API pre Katalóg Microsoft Learn umožňuje odoslať webový dotaz do služby Microsoft Learn a získať informácie o dostupnom obsahu školení a certifikačných skúškach, ako sú napríklad tituly, produkty, ktoré pokrýva, trvanie, adresy URL a ďalšie. Je to webové rozhranie API založené na architektúre REST, ktoré vracia odozvu kódovanú použitím JSON.

Vráti informácie o všetkých verejne dostupných:

  • Moduly
  • Lekcie
  • Študijné programy
  • Instructor-Led courses
  • Skúšky
  • Certifikácie

Rozhranie API pre Microsoft Learn Catalog je k dispozícii v rámci podmienok, ktoré sú uvedené v podmienkach používania rozhraní API od spoločnosti Microsoft.

Táto stránka poskytuje technické podrobnosti o rozhraní API a o tom, ako interpretovať získané informácie. Toto rozhranie API sa bežne používa na dotazovanie informácií a ich vystavenie v iných systémoch. Ak chcete preskúmať spôsoby integrácie tohto rozhrania API s ďalšími funkciami služby Microsoft Learn, pozrite si článok Využitie služby Learn vo vašej organizácii.

Poznámka

Toto rozhranie API bolo nedávno aktualizované tak, aby zahŕňalo kurzy vedené inštruktorom, skúšky, certifikácie, zoznamy jednotiek pre moduly a snímky vo formáte PNG. Nižšie nájdete ďalšie podrobnosti.

Koncový bod rozhrania API

Rozhranie API pre Microsoft Learn Catalog je webovým rozhraním API založeným na architektúre REST, ktoré vracia odozvu kódovanú použitím JSON. Ak chcete požiadať o úplný katalóg, odošlite žiadosť GET na:

https://docs.microsoft.com/api/learn/catalog/

Dôležité

Žiadosť musí používať protokol HTTPS.

Parametre dotazu

Nižšie sú uvedené parametre dotazu, ktoré môže žiadosť obsahovať. Požadovaný stĺpec udáva, či je potrebné zadať parameter. Musíte URL adresu zakódovať pomocou hodnôt parametrov dotazu.

Name Hodnota Typ Povinné
locale Platný kód miestnych nastavení zo zoznamu podporovaných miestnych nastavení, napríklad sk-sk. Vrátené metaúdaje budú mať požadovaný formát podľa miestnych nastavení. Ak tento parameter nebol zadaný, použije sa predvolená hodnota en-us. reťazec No

Odpoveď rozhrania API

Služba môže vrátiť nasledujúce kódy stavu protokolu HTTP.

Kód stavu Description
200 Úspešné. Telo odozvy obsahuje údaje kódované použitím JSON.
400 Jeden z parametrov dotazu chýba alebo je neplatný.
404 URL adresa sa nenašla na serveri.
500 Neočakávaná chyba servera.
503 Služba je dočasne nedostupná.

Odpoveď na správne zadefinovaný dotaz bude obsahovať podrobnosti o všetkých moduloch a študijných programoch, ako je to znázornené nižšie.

Tip

Odporúča sa pravidelne a nie len v prípade potreby skopírovať odozvu do vyrovnávacej pamäte a obnoviť zobrazenie údajov.

Text odozvy

Text úspešnej odpovede bude kódovaný vo formáte JSON a bude mať deväť častí:

{
    "modules": [ ... ],
    "units": [...],
    "learningPaths": [ ... ],
    "certifications": [ ... ],
    "exams": [ ... ],
    "courses": [ ... ],
    "levels": [ ... ],
    "products": [ ... ],
    "roles": [ ... ],
    "subjects": [...],
}

Každé pole obsahuje minimálne jeden objekt zakódovaný použitím JSON a obsahujúci údaje špecifické pre danú časť odpovede.

  1. modules: je pole publikovaných modulov.
  2. units: je pole publikovaných jednotiek.
  3. learningPaths: je pole publikovaných študijných programov.
  4. certifications: je pole publikovaných certifikácií.
  5. exams: je pole publikovaných skúšok.
  6. courses: je pole publikovaných kurzov školení vedených inštruktorom.
  7. levels: je pole možných úrovní príjemcov.
  8. products: je pole možných produktov a služieb, ktoré sú popísané v katalógu.
  9. roles: je pole možných úrovní úloh.
  10. subjects: je pole možných značiek predmetu.

Záznamy modulov

Každý záznam modulu bude mať nasledujúci tvar:

{
    "summary": "Explore the core concepts of cloud computing and how it can help your business.",
    "levels": [
        "beginner"
    ],
    "roles": [
        "administrator",
        "business-analyst",
        "developer"
    ],
    "products": [
        "azure",
        "azure-portal",
        "azure-resource-manager"
    ],
    "subjects": [
        "data-visualization"
    ],
    "uid": "learn.principles-cloud-computing",
    "type": "module",
    "title": "Cloud Concepts - Principles of cloud computing",
    "duration_in_minutes": 62,
    "rating": {
        count: 2014,
        average: 4.84
    },
    "popularity": 0.8839785477023878, 
    "icon_url": "https://docs.microsoft.com/learn/achievements/principles-cloud-computing.svg",
    "social_image_url": "https://docs.microsoft.com/learn/achievements/principles-cloud-computing-social.png",
    "locale": "en-us",
    "last_modified": "2018-09-24T00:00:00Z",
    "url": "https://docs.microsoft.com/en-us/learn/modules/principles-cloud-computing",
    "firstUnitUrl": "https://docs.microsoft.com/en-us/learn/modules/principles-cloud-computing/1-introduction",
    "units": [
        "learn.principles-cloud-computing.1-introduction",
        "learn.principles-cloud-computing.2-types-of-cloud-computing",
        "learn.principles-cloud-computing.3-benefits-of-cloud-computing",
        "learn.principles-cloud-computing.4-categories-of-cloud-services",
        "learn.principles-cloud-computing.5-knowledge-check",
        "learn.principles-cloud-computing.6-summary"
    ],
    "number_of_children": 6
}

Podrobnosti poľa

Pole Typ Description
summary reťazec Reťazec, ktorý obsahuje krátky popis modulu. Hodnota sa vyjadruje ako značka odseku HTML s vnútorným textom, ktorý je súhrnom.
levels pole reťazcov Zoznam úrovní priradených k tomuto modulu, ktoré označujú, koľko skúseností v danej úlohe je potrebné na pochopenie všetkých aspektov tohto modulu. Na podrobnosti o jednotkách môžete odkazovať v záznamoch na úrovni.
roles pole reťazcov Zoznam povolaní, pre ktoré je tento modul relevantný.
products pole reťazcov Zoznam relevantných produktov, ku ktorým sa modul vzťahuje. Podrobnosti o produktoch môžete odkazovať v záznamoch produktov.
subjects pole reťazcov Zoznam relevantných predmetov, ktoré študijný program zahŕňa.
uid reťazec Jedinečný identifikátor pre tento modul – táto hodnota bude jedinečná v rámci celej služby MS Learn.
type reťazec Typ záznamu. Hodnotou bude vždy „modul“.
title reťazec Názov modulu v požadovanom miestnom jazyku (prípadne v americkej angličtine).
duration_in_minutes celé číslo Priemerný čas splnenia tohto modulu v minútach.
rating objekt Zahŕňa tak položku , čo je počet ľudí, ktorí ohodnotili modul, ako averageaj countpoložku , čo je súhrn hodnotení, ktorý bude v rozsahu 1 – 5.
popularity dvojité Normalizovaná hodnota v rozsahu 0 – 1 označujúca popularitu daného modulu.
icon_url reťazec Plne kvalifikovaná URL adresa k obrázku veľkosti 100 x 100 SVG, ktorý predstavuje obrázok s výsledkom modulu s priehľadným pozadím.
social_image_url Reťazec Plne kvalifikovaná URL adresa na obrázok vo formáte PNG, ktorý predstavuje obrázok dosiahnutého modulu s obdĺžnikovým nepriehľadným pozadím, vhodným pre skúsenosti so sociálnymi médiami alebo dlaždicami. Ak nie je k dispozícii pre tento modul, táto vlastnosť sa nevracia v odpovedi.
locale reťazec Jazyk, v ktorom sú tieto údaje JSON napísané. Táto hodnota bude požadovaným miestnym jazykom, ak je dostupný, alebo v prípade jeho nedostupnosti to bude en-us.
last_modified dátum Čas poslednej hlavnej revízie tohto modulu.
url reťazec Úplná URL adresa modulu v službe Microsoft Learn v požadovanom miestnom jazyku.
firstUnitUrl Reťazec Úplná URL adresa prvej lekcie modulu v službe Microsoft Learn v požadovanom miestnom jazyku.
units pole reťazcov Zoznam priradených U ID jednotiek. Na podrobnosti o jednotkách možno odkazovať v záznamoch jednotiek.
number_of_children celé číslo Počet strán (jednotiek), ktoré tento modul obsahuje.

Záznamy jednotiek

Každý záznam jednotky bude mať nasledujúci tvar:

{
    "uid": "learn.azure.fundamental-azure-concepts.types-of-cloud-computing",
    "type": "unit",
    "title": "Discuss different types of cloud models",
    "duration_in_minutes": 5,
    "locale": "en-us",
    "last_modified": "2021-12-09T02:45:00+00:00"
},

Poznámka

Záznam jednotky nemá priradenú URL adresu, pretože jednotky nie sú napísané ako samostatný obsah. Sú určené na použitie v špecifickom poradí pre modul. Z tohto dôvodu zahrnieme prepojenie na stránku s podrobnosťami modulu a prvú lekciu v zázname modulu, aby tam používatelia mohli začať a pokračovať v obsahu. Záznamy lekcie však možno použiť na získanie podrobností o jednotkách, ktoré sa majú zobraziť v systéme LMSe alebo iných prostrediach.

Podrobnosti poľa

Pole Typ Description
uid reťazec Jedinečný identifikátor pre tento modul – táto hodnota bude jedinečná v rámci celej služby MS Learn.
type reťazec Typ záznamu. Hodnotou bude vždy "jednotka".
title Reťazec Názov lekcie v požadovanom miestnom jazyku (prípadne v americkej angličtine).
duration_in_minutes Trvanie lekcie. Ak pridáte všetky duration_in_minutes jednotiek priradených k každému modulu, získate celkový čas modulu.
locale reťazec Jazyk, v ktorom sú tieto údaje JSON napísané. Táto hodnota bude požadovaným miestnym jazykom, ak je dostupný, alebo v prípade jeho nedostupnosti to bude en-us.
last_modified dátum Čas poslednej hlavnej revízie tohto modulu.

Záznamy študijného programu

Každý záznam študijného programu bude mať nasledujúci formát:

{
    "summary": "Azure Functions enable the creation of event driven, compute-on-demand systems that can be triggered by various external events. Learn how to leverage functions to execute server-side logic and build serverless architectures.",
    "levels": [
        "beginner",
        "intermediate"
    ],
    "roles": [
        "developer",
        "solution-architect"
    ],
    "products": [
        "azure",
        "azure-portal",
        "azure-functions",
        "azure-cosmos-db",
        "azure-cloud-shell"
    ],
    "subjects": [
        "data-visualization"
    ],
    "uid": "learn.create-serverless-applications",
    "type": "learningPath",
    "title": "Create serverless applications",
    "duration_in_minutes": 450,
    "rating": {
        count: 2014,
        average: 4.84
    },
    "popularity": 0.8839785477023878, 
    "icon_url": "https://docs.microsoft.com/learn/achievements/create-serverless-applications.svg",
    "social_image_url": "https://docs.microsoft.com/learn/achievements/create-serverless-applications-social.png",
    "locale": "en-us",
    "last_modified": "2018-12-27T00:00:00Z",
    "url": "https://docs.microsoft.com/en-us/learn/paths/create-serverless-applications",
    "firstModuleUrl": "https://docs.microsoft.com/en-us/learn/modules/choose-azure-service-to-integrate-and-automate-business-processes/",
    "modules": [
        "learn.choose-azure-service-to-integrate-and-automate-business-processes",
        "learn.create-serverless-logic-with-functions",
        "learn.execute-azure-function-with-triggers",
        "learn.chain-azure-functions-data-using-input-output-bindings",
        "learn.azure-create-long-running-serverless-workflow-with-durable-functions",
        "learn-pr.develop-test-deploy-azure-functions-core-tools",
        "learn.develop-test-deploy-azure-functions-with-visual-studio",
        "learn.azure.monitor-github-events-with-a-function-triggered-by-a-webhook",
        "learn.advocates.azure-functions-and-signalr"
    ],
    "number_of_children": 9
}

Podrobnosti poľa

Pole Typ Description
summary reťazec Reťazec, ktorý obsahuje krátky popis študijného programu. Hodnota sa vyjadruje ako značka odseku HTML s vnútorným textom, ktorý je súhrnom.
levels pole reťazcov Zoznam úrovní priradených k tomuto študijného programu, ktoré označujú, koľko skúseností v danej role je potrebné na pochopenie všetkých aspektov tohto študijného programu. Na podrobnosti o jednotkách možno odkazovať v záznamoch na úrovni.
roles pole reťazcov Zoznam relevantných rolí úloh pre tento študijný program.
products pole reťazcov Zoznam relevantných produktov, ku ktorým sa študijný program vzťahuje. Na podrobnosti o produktoch sa môžu odkazovať v záznamoch produktov.
subjects pole reťazcov Zoznam relevantných predmetov, ktoré študijný program pokrýva.
uid reťazec Jedinečný identifikátor pre tento študijný program – táto hodnota bude jedinečná v rámci celej služby MS Learn.
type reťazec Typ záznamu. Hodnotou bude vždy „študijnýProgram“.
title reťazec Názov študijného programu v požadovanom miestnom jazyku (prípadne v americkej angličtine).
duration_in_minutes celé číslo Priemerný čas splnenia tohto študijného programu v minútach. Táto hodnota je súčtom údajov zo všetkých zahrnutých modulov.
rating objekt Obsahuje tak položku , čo je počet ľudí, ktorí ohodnotili študijný program, ako averageaj countpoložku , čo je súhrn hodnotení, ktorý bude v rozsahu 1 – 5.
popularity dvojité Normalizovaná hodnota v rozsahu 0 – 1 označujúca popularitu daného študijného programu.
icon_url reťazec Plne kvalifikovaná URL adresa k obrázku svg s veľkosti 100 x 100, ktorý predstavuje študijný program.
social_image_url Reťazec Plne kvalifikovaná URL adresa na obrázok vo formáte PNG, ktorý predstavuje obrázok študijného programu s obdĺžnikovým nepriehľadným pozadím, vhodný pre skúsenosti so sociálnymi médiami alebo dlaždicami. Ak nie je k dispozícii pre tento modul, táto vlastnosť sa nevracia v odpovedi.
locale reťazec Jazyk, v ktorom sú tieto údaje JSON napísané. Táto hodnota bude požadovaným miestnym jazykom, ak je dostupný, alebo v prípade jeho nedostupnosti to bude en-us.
last_modified dátum Čas poslednej zmeny tohto študijného programu.
url reťazec Úplná URL adresa študijného programu v službe Microsoft Learn v požadovanom miestnom jazyku.
firstModuleUrl Reťazec Úplná URL adresa prvého modulu študijného programu v službe Microsoft Learn v požadovanom miestnom jazyku.
modules pole reťazcov Zoznam priradených identifikátorov U ID modulu. Na podrobnosti o moduloch možno odkazovať v záznamoch modulov.
number_of_children celé číslo Počet modulov, ktoré študijný program obsahuje

Záznamy certifikácie

Každý záznam certifikácie bude mať nasledujúci tvar:

{
    "uid": "certification.d365-functional-consultant-customer-service",
    "title": "Microsoft Certified: Dynamics 365 Customer Service Functional Consultant Associate",
    "subtitle": "Microsoft Dynamics 365 Customer Service functional consultants are responsible for implementing omnichannel solutions that focus on service, quality, reliability, efficiency, and customer satisfaction.",
    "url": "https://docs.microsoft.com/en-us/cert-exam-sandbox/cert/?WT.mc_id=api_CatalogApi",
    "icon_url": "https://docs.microsoft.com/en-us/media/learn/certification/badges/microsoft-certified-associate-badge.svg",
    "type": "cert",
    "certification_type": "role-based",
    "exams": [
        "exam.77-881"
    ],
    "levels": [
        "intermediate"
    ],
    "roles": [
        "functional-consultant"
    ],
    "study_guide": [
        {
            "uid": "learn.get-started-with-d365",
            "type": "module"
        },
        {
            "uid": "learn.d365-notebook",
            "type": "module"
        },
        {
            "uid": "learn.d365-fundamentals",
            "type": "learningPath"
        }
    ]
}

Podrobnosti poľa

Pole Typ Description
uid reťazec Jedinečný identifikátor pre túto certifikáciu – táto hodnota bude jedinečná v rámci celej služby MS Learn.
title Reťazec Názov pre certifikáciu v požadovanom miestnom jazyku (prípadne v americkej angličtine).
subtitle Reťazec Podnadpis k certifikácii v požadovanom miestnom jazyku (prípadne v americkej angličtine).
url Reťazec Plne kvalifikovaná URL adresa certifikácie v službe Microsoft Learn v požadovanom miestnom jazyku.
icon_url Reťazec Plne kvalifikovaná URL adresa k obrázku veľkosti 100 x 100 SVG, ktorý predstavuje certifikáciu.
type reťazec Typ záznamu. Hodnotou bude vždy "cert".
certification_type Reťazec Typ certifikácie. Medzi možné hodnoty patria "základy", "mce", "mcsa", "mcsd", 'mcse', 'mos', 'mta', 'role-based', 'specialty'.
exams pole reťazcov Zoznam priradených skúšok potrebných pre túto certifikáciu. Na podrobnosti o jednotkách možno odkazovať v záznamoch certifikácie.
levels pole reťazcov Zoznam úrovní priradených k tejto certifikácii, ktorý uvádza, koľko skúseností v danej role je potrebné na pochopenie všetkých aspektov skúšok tejto certifikácie. Na podrobnosti o jednotkách možno odkazovať v záznamoch na úrovni.
roles pole reťazcov Zoznam relevantných rolí úloh pre túto certifikáciu. Na podrobnosti o rolách možno odkazovať v záznamoch rolí.
study_guide pole objektov Zoznam súvisiaceho obsahu, ktorý sa má študovať pre túto certifikáciu. Na podrobnosti o objektoch možno odkazovať v ich priradených záznamoch.

Záznamy skúšky

Každý záznam skúšky bude mať nasledujúci tvar:

{
    "uid": "exam.77-881",
    "title": "Word 2010",
    "subtitle": "The core-level Microsoft Office Word 2010 user should be able to navigate Microsoft Office Word 2010 software at the feature and functional level. They should be familiar with and know how to use at least 80 percent of the features and capabilities of Microsoft Office Word 2010. The core-level user should be able to use Microsoft Office Word 2010 to create and edit professional-looking documents for a variety of purposes and situations. Users would include people from a wide variety of job roles from almost all areas of professional, student, and personal life.",
    "display_name": "77-881",
    "url": "https://docs.microsoft.com/en-us/cert-exam-sandbox/exam/77-881/?WT.mc_id=api_CatalogApi",
    "icon_url": "https://docs.microsoft.com/en-us/media/learn/certification/badges/certification-exam.svg",
    "pdf_download_url": "https://query.prod.cms.rt.microsoft.com/cms/api/am/binary/RE4trjX",
    "practice_test_url": "https://www.mindhub.com/70-413-Designing-and-Implementing-a-Server-Infrast-p/mu-70-413_p.htm?utm_source=microsoft&utm_medium=certpage&utm_campaign=msofficialpractice",
    "locales": [],
    "type": "exam",
    "courses": [
        "course.pl-200t00",
        "course.mb-230t01"
    ],
    "levels": [
        "beginner"
    ],
    "roles": [
        "business-user"
    ],
    "products": [
        "office-word"
    ],
    "providers": [],
    "study_guide": [
        {
            "uid": "learn.get-started-with-word-2010",
            "type": "module"
        },
        {
            "uid": "learn.office2010-notebook",
            "type": "module"
        },
        {
            "uid": "learn.office2010-fundamentals",
            "type": "learningPath"
        }
    ]
}

Podrobnosti poľa

Pole Typ Description
uid reťazec Jedinečný identifikátor tejto skúšky – táto hodnota bude jedinečná v rámci celej služby MS Learn.
title Reťazec Názov skúšky v požadovanom miestnom jazyku (prípadne v americkej angličtine).
subtitle Reťazec Podnadpis na skúšku v požadovanom miestnom jazyku (prípadne v americkej angličtine).
display_name Reťazec Zobrazovaný názov skúšky v požadovanom miestnom jazyku (prípadne v americkej angličtine).
url Reťazec Plne kvalifikovaná URL adresa na skúšku v službe Microsoft Learn v požadovanom miestnom jazyku.
icon_url Reťazec Plne kvalifikovaná URL adresa k obrázku veľkosti 100 x 100 SVG, ktorý predstavuje skúšku.
pdf_download_url Reťazec Plne kvalifikovaná URL adresa do PDF súboru, ktorá poskytuje znalosti merané touto skúškou.
practice_test_url Reťazec Plne kvalifikovaná URL adresa praktického testu súvisiaceho so skúškou.
locales pole reťazcov Zoznam jazykov, v prípade ktoré je táto skúška k dispozícii.
type reťazec Typ záznamu. Hodnotou bude vždy "skúška".
courses pole reťazcov Zoznam priradených U ID kurzov. Na podrobnosti o kurzoch je možné odkazovať v záznamoch kurzu.
levels pole reťazcov Zoznam úrovní súvisiacich s touto skúškou, ktoré označujú, koľko skúseností v danej úlohe je potrebné na pochopenie všetkých aspektov tejto skúšky. Na podrobnosti o jednotkách možno odkazovať v záznamoch na úrovni.
roles pole reťazcov Zoznam relevantných rolí úloh pre túto skúšku. Na podrobnosti o rolách možno odkazovať v záznamoch rolí.
products pole reťazcov Zoznam relevantných produktov, na ktoré sa táto skúška vzťahuje. Na podrobnosti o produktoch sa môžu odkazovať v záznamoch produktov.
providers pole objektov Zoznam poskytovateľov tejto skúšky. Typ popisuje poskytovateľa a úplnú URL adresu s prepojením na naplánovanie skúšky s poskytovateľom.
study_guide pole objektov Zoznam súvisiaceho obsahu, ktorý sa má študovať na túto skúšku. Na podrobnosti o objektoch možno odkazovať v ich priradených záznamoch.

Záznamy kurzu vedené inštruktorom

Každý záznam kurzu bude mať nasledujúci formulár:

{
    "uid": "course.mb-230t01",
    "course_number": "MB-230T01",
    "title": "Microsoft Dynamics 365 Customer Service - added non-exist studyguide",
    "summary": "Microsoft Dynamics 365 Customer Service offers any organization an opportunity for customer success. Using tools such as automatic case creation and queue management frees up your time to dedicate it where you can have a greater impact, directly with your customers.Join our team of globally recognized experts as they take you step by step from creating cases to interacting with customers to resolving those cases. Once you’ve resolved those cases you can learn from data analysis the key details to help you resolve similar cases faster or avoid new issues altogether. A Dynamics 365 Customer Engagement Functional Consultant is responsible for performing discovery, capturing requirements, engaging subject matter experts and stakeholders, translating requirements, and configuring the solution and applications. The Functional Consultant implements a solution using out of the box capabilities, codeless extensibility, application and service integrations.",
    "duration_in_hours": 72,
    "url": "https://docs.microsoft.com/en-us/cert-exam-sandbox/course/mb-230t01/?WT.mc_id=api_CatalogApi",
    "icon_url": "https://docs.microsoft.com/en-us/media/learn/certification/course.svg",
    "locales": [
        "en"
    ],
    "type": "course",
    "certification": "certification.d365-functional-consultant-customer-service",
    "exam": "exam.77-881",
    "levels": [
        "intermediate"
    ],
    "roles": [
        "functional-consultant"
    ],
    "products": [
        "dynamics-365"
    ],
    "study_guide": [
        {
            "uid": "learn.align-requirements-in-azure",
            "type": "module"
        },
        {
            "uid": "learn.manage-resources-in-azure",
            "type": "learningPath"
        }
    ]
},

Podrobnosti poľa

Pole Typ Description
uid reťazec Jedinečný identifikátor tohto kurzu vedeného inštruktorom – táto hodnota bude jedinečná v rámci celej služby MS Learn.
course_number Reťazec Identifikátor čísla kurzu vedeného inštruktorom.
title Reťazec Názov kurzu vedeného inštruktorom v požadovanom miestnom jazyku (prípadne v americkej angličtine).
summary Reťazec Reťazec, ktorý obsahuje krátky popis vedeného inštruktorom. Hodnota sa vyjadruje ako značka odseku HTML s vnútorným textom, ktorý je súhrnom.
duration_in_hours celé číslo Priemerný čas dokončenia tohto kurzu vedeného inštruktorom v hodinách.
url Reťazec Plne kvalifikovaná URL adresa na stránku s podrobnosťami o kurze vedeným inštruktorom v službe Microsoft Learn v požadovanom miestnom jazyku.
icon_url Reťazec Plne kvalifikovaná URL adresa k obrázku svg s veľkosti 100 x 100, ktorý predstavuje úspech v kurze vedený inštruktorom.
locales pole reťazcov Zoznam jazykov, v tomto kurze vedený inštruktorom, je oficiálne k dispozícii. Vzdelávanie partnerov môže podporovať aj iné jazyky.
type reťazec Typ záznamu. Hodnotou bude vždy "kurz" pre kurzy vedené inštruktorom.
certification Reťazec Certifikácia priradená kurzu vedenému inštruktorom.
exam Reťazec Skúška spojená s kurzom vedeným inštruktorom.
levels pole reťazcov Zoznam úrovní spojených s týmto kurzom vedeným inštruktorom, ktorý uvádza, koľko skúseností v danej úlohe je potrebné na pochopenie všetkých aspektov tohto kurzu. Na podrobnosti o jednotkách môžete odkazovať v záznamoch na úrovni.
study_guide pole objektov Plne kvalifikovaná URL adresa súboru PDF, ktorá poskytuje prehľad zručností meraných touto certifikáciou.

Záznamy úrovne, produktu, roly a predmetu

levelsKolekcie , products, rolesa subjects obsahujú popisné názvy hodnôt používaných v údajoch modulu a študijného programu. Všetky štyri kolekcie majú rovnaký tvar:

{
    "id": "unique-id",
    "name": "name-of-item",
    "children": [
        { "id": "unique-id", "name": "name-of-item" },
        { "id": "unique-id", "name": "name-of-item" },
           ...
    ]
}

Hodnota id sa bude zhodovať s hodnotami úrovní, produktov, rolí a predmetov zahrnutých v iných položkách katalógu. Priradená hodnota name obsahuje správny názov položky v angličtine. Pole children je voliteľné a umožňuje hierarchické usporiadanie hodnôt, ktoré majú podriadené vzťahy, ako sú napríklad produkty.

Tu je napríklad množina možných rolí:

{
    ...
    "roles": [
        {
            "id": "administrator",
            "name": "Administrator"
        },
        {
            "id": "ai-engineer",
            "name": "AI Engineer"
        },
        {
            "id": "business-analyst",
            "name": "Business Analyst"
        },
        {
            "id": "developer",
            "name": "Developer"
        },
        ...
    ]
}

Tu je príklad množiny produktov s podradenými položkami, ktorý popisuje presnejšiu kategóriu produktu.

{
    ...
    "products": [
        {
            "id": "dotnet",
            "name": ".NET",
            "children": [
                { "id": "dotnet-core", "name": ".NET Core" },
                { "id": "dotnet-standard", "name": ".NET Standard" },
                { "id": "aspnet-core", "name": "ASP.NET Core" },
                { "id": "ef-core", "name": "Entity Framework Core" }
            ]
        },
        {
            "id": "ms-graph",
            "name": "Microsoft Graph"
        },
        {
            "id": "office",
            "name": "Office",
            "children": [
                { "id": "office-365", "name": "Office 365" },
                { "id": "office-add-ins", "name": "Office Add-ins" },
                { "id": "office-teams", "name": "Teams" }
            ]
        },
        {
            "id": "sql-server",
            "name": "SQL Server"
        },
        ...
    ]
}

Vzorové kódy

Rozhranie API pre Katalóg Learn možno volať mnohými spôsobmi, ale toto sú najrôznejšie vzorky kódu, ktoré možno použiť.

Jquery

$(function() {
    var params = {
        locale:'en-us'
    };
    $.ajax({
        url: "https://docs.microsoft.com/api/learn/catalog?" + $.param(params),
            type: "GET"
    }).done(function(data) {
        alert("success");
    }).fail(function(error) {
        alert("error");
    });
})

.NET C #

public string GetCatalogData()
{
var client = new WebClient();
client.Headers.Add(HttpRequestHeader.UserAgent, "Mozilla/5.0 (Windows NT 10.0; WOW64; Trident/7.0; rv:11.0) like Gecko");
var response = client.DownloadString("https://docs.microsoft.com/api/learn/catalog?locale=en-us");
dynamic parsedJson = JsonConvert.DeserializeObject(response);
JsonConvert.SerializeObject(response, Formatting.Indented);
return Convert.ToString(response);
}

PHP pomocou rozšírenia cURL

<?php 

// From URL to get webpage contents. 
$url = "https://docs.microsoft.com/api/learn/catalog"; 

// Initialize a CURL session. 
$ch = curl_init(); 

// Return Page contents. 
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
 
//grab URL and pass it to the variable. 
curl_setopt($ch, CURLOPT_URL, $url); 

$result = curl_exec($ch); 

echo $result;

?>

Python 3 pomocou knižnice requests


#!/usr/bin/env python3
#Using Python 3.8.2 install 5/6/2020

import requests
import json

#if given error 'response / requests not defined', install requests via 'pip install requests' in the command line

parameters= {"locale": "en-us"}

response = requests.get("https://docs.microsoft.com/api/learn/catalog/", parameters)

#print(response.status_code)

rawJson = response._content

#Create python objects based on the data using json.loads

data = json.loads(rawJson)

print(data)

Popisy typov katalógu

Webové (asynchrónne) školenie

Webový (asynchrónny) vzdelávací obsah v službe Microsoft Learn je štruktúrovaný hierarchicky. Moduly sú najvýznamnejším typom obsahu, pretože ide o samostatný kurz. Ďalšie podrobnosti o každom webovom type obsahu v téme Learn a ich štruktúre sú uvedené nižšie.

Graphical depiction of Microsoft Learn content structure. Learning paths are a bundle of modules. Modules are a bundle of units.

Lekcie

Lekcia obsahuje skutočný obsah školenia prezentovaný ako jednotlivé webové stránky s rôznymi skúsenosťami (text iba na text a video, kontroly vedomostí, interaktívne skúsenosti a ďalšie). Napriek tomu, že používatelia získajú kredit za dokončenie jednotlivej lekcie, nie sú to samostatné školenia. Každá lekcia je podmnožinou modulu (a priradená iba jednému modulu).

Nižšie je zobrazená snímka obrazovky lekcie, ktorá má povolené testovacie prostredie (sandbox) služby Azure Cloud Shell.

Screenshot of a Microsoft Learn unit with training content text and sandbox side-by-side

Ak si chcete pozrieť živý príklad lekcie, navštívte lokalitu Zapisovanie do viacerých oblastí, čo je lekcia v module Distribúcia údajov globálne pomocou modulu Azure Cosmos DB.

Ak chcete skontrolovať podrobnosti o odpovedi zariadenia v rozhraní API, navštívte časť Záznamy zariadenia v časti odpovede rozhrania API nižšie.

Moduly

Modul je samostatný asynchrónny webový kurz školenia na lokalite Microsoft Learn. Zvyčajne sú malé (menej ako hodinu) a skúmajú službu alebo technológiu, pričom často poskytujú určitú formu interaktivity na vyskúšanie technológie. Moduly možno považovať za samostatné alebo v kontexte jedného alebo viacerých študijných kurzov.

Každý modul sa skladá z viacerých webových stránok nazývaných jednotky a súvisiacich metaúdajov na rýchlu identifikáciu používateľa, časti zobrazenia a času potrebného na dokončenie daného modulu. Tieto podrobnosti sú zobrazené v grafických dlaždiciach na stránke prehľadávania služby Microsoft Learn, ako vidíte na tejto snímke obrazovky.

Screenshot showing a single module with all the details from the Microsoft Learn website

Ak si chcete pozrieť živý príklad modulu, pozrite si tému Globálne distribuovanie údajov pomocou databázy Azure Cosmos DB.

Ak chcete skontrolovať podrobnosti o odpovedi modulu v rozhraní API, navštívte časť Záznamy modulov v časti odozvy rozhrania API nižšie.

Študijné programy

Študijný program predstavuje kolekciu súvisiacich modulov zobrazených v špecifickom poradí, aby moduly navzájom vychádzali a naučili širšiu odbornosť. Študijné programy obsahujú aj popisné metaúdaje podobné modulom, ako je to znázornené na snímke obrazovky na stránke prehľadávania nižšie.

Screenshot showing a learning path from the Microsoft Learn website

Ak si chcete pozrieť živý príklad študijného programu, pozrite si tému Práca s údajmi NoSQL v databáze Azure Cosmos DB.

Ak chcete skontrolovať podrobnosti o odpovedi študijného programu v rozhraní API, navštívte Vzdelávanie záznamy cesty v časti odpovede rozhrania API nižšie.

Školenie s inštruktorom

Školenia vedené inštruktorom, ktoré ponúka spoločnosť Microsoft a jej partneri pre doručovanie, je možné vyhľadať a zaregistrovať sa prostredníctvom služby Microsoft Learn. Tieto kurzy vedené inštruktorom sú k dispozícii prostredníctvom rozhrania API služby Learn Catalog.

Kurz

Kurz vedený inštruktorom je synchrónne školenie, ktoré prednáša inštruktor.

Screenshot showing the detail page of Course MB-220T00: Microsoft Dynamics 365 Marketing

Ak si chcete pozrieť živý príklad kurzu vedeného inštruktorom, prejdite na kurz MB-220T00: Microsoft Dynamics 365 Marketing.

Ak chcete skontrolovať podrobnosti o odpovedi kurzu v rozhraní API, navštívte časť Záznamy kurzu v časti odpovede rozhrania API nižšie.

Skúšky a certifikácie

Profesionálne poverenia sú pre niektorých študentov dôležitým cieľom. Spoločnosť Microsoft ponúka viacero certifikácií v celom odvetví, ktoré je možné dosiahnuť absolvovaním skúšok, a zdieľať ich so zamestnávateľmi. Certifikácie a súvisiace skúšky sú k dispozícii na registráciu prostredníctvom lokality Microsoft Learn a podrobností dostupných v rozhraní API pre Katalóg Learn.

Graphical depiction of certification pathway for the Microsoft Certified: Azure Administrator Associated certification. Take one exam (Microsoft Azure Administrator), earn the certification (Microsoft Certified: Azure Administrator Associate)

Skúška

Skúška je odporúčaným testom, ktorý používateľ absolvuje ako súčasť získania certifikácie.

Screenshot showing the detail page that allows people to schedule a certification exam

Ak si chcete pozrieť živý príklad stránky s podrobnosťami o skúške, prejdite na stránku Exam AZ-104: Microsoft Azure Administrator (Správca služby Microsoft Azure). Ak chcete zobraziť podrobnosti o odpovedi rozhrania API pre skúšky, pozrite si časť Skúška nižšie.

Ak chcete skontrolovať podrobnosti o odpovedi na skúšku v rozhraní API, navštívte časť Záznamy skúšky v časti odpovede rozhrania API nižšie.

Certifikácia

Certifikácia je profesionálne poverenie získané úspešným dokončením jednej alebo viacerých skúšok.

Screenshot showing the transcript record of a Microsoft Certified Educator Certification achievement

Ak si chcete pozrieť živý príklad stránky s podrobnosťami o certifikácii, navštívte lokalitu Certifikované spoločnosťou Microsoft: Azure Administrator Associate.

Ak chcete skontrolovať podrobnosti o odpovedi na certifikáciu v rozhraní API, navštívte časť Certifikačné záznamy v časti odpovede rozhrania API nižšie.

Najčastejšie otázky

Otázka: Je školenie k dispozícii v iných jazykoch?

To závisí od rôznych faktorov. Väčšina obsahu je k dispozícii v jazykoch dostupných pre produkty, ktoré učí.

Otázka: Zostávajú údaje vrátené z rozhrania API pre Catalog statické alebo sa zmenia?

Údaje sa zmenia pri každom pridaní nového obsahu, čo je zvyčajne aspoň raz za týždeň.

Otázka: Prečo sú v súhrne modulu značky HTML?

Zvyčajne sa snažíme ponechať formátovanie súhrnu čo nespracované, ale niekedy musíme zdôrazniť alebo prepojiť určitý text.

Otázka: Je UID jedinečné pre obsah?

Áno.

Otázka: Prečo nie sú prepojenia na jednotlivé jednotky?

Jednotky nie sú napísané ako samostatný obsah. Tieto jednotky sú určené na špecifické poradie modulu. Z tohto dôvodu zahrnieme prepojenie na stránku s podrobnosťami o module a prvú lekciu, aby tam používatelia mohli začať a pokračovať v obsahu.

Otázka: Ako zistím, ktorý obsah je nový?

Hodnota last_modified zobrazí, kedy bol záznam naposledy upravený.

Otázka: Sú všetky moduly súčasťou študijného programu?

Nie. Moduly sú samostatné v tom zmysle, že učia scenár alebo koncept od konca v rámci nich. Pre niektorých je to ono a nie sú súčasťou študijného programu. Pre iných sú zoskupené v jednom alebo viacerých študijných programoch, ktoré preberajú používateľa prostredníctvom vytvárania pokročilejších konceptov. Modul nemusí byť súčasťou študijného programu alebo môže byť súčasťou jedného alebo viacerých častí.

Otázka: Umožní toto rozhranie API našim používateľom používať obsah Na lokalite Learn v rámci našej platformy?

Nie. Rozhranie API pre Catalog poskytuje metaúdaje vrátane priamych prepojení na obsah. Partneri ich môžu integrovať do ľubovoľného prostredia LMS alebo webového prostredia.

Otázka: Existuje rozhranie API na vytváranie zostáv na získanie údajov, ako sú zobrazenia, kliknutia, dokončenie?

Nie. Funkcie na vytváranie zostáv pre organizácie však umožňujú organizáciám vykonávať zostavy o dokončeniach používateľov. Ak chcete preskúmať spôsoby integrácie tohto rozhrania API s ďalšími funkciami služby Microsoft Learn, pozrite si článok Využitie služby Learn vo vašej organizácii.

Otázka: Je pre tieto prepojenia povolené jediné prihlásenie?

Momentálne nie. Máme to v pláne na budúcu iteráciu.

Program rozhrania API pre Catalog

Integrujete obsah služby Microsoft Learn so svojou vzdelávacou platformou? Požiadajte o Program rozhrania API pre Catalog (CAP), aby náš tím pomohol zabezpečiť najlepšie integračné prostredie a získať vstup v budúcich verziách rozhrania API pre Catalog.

Pripomienky a podpora

Rozhranie API pre Catalog je momentálne k dispozícii bez zmluvy na úrovni služby. Ak máte nejaké návrhy alebo ste pri používaní rozhrania API narazili na problém, môžete príslušnému tímu poslať pripomienky.