Referenční dokumentace k rozhraní API katalogu Microsoft Learn

Článek
10/26/2023

Tento článek obsahuje informace pro vývojáře a žadatele, kteří implementuje rozhraní API katalogu Microsoft Learn. Doporučujeme také projděte si osvědčené postupy rozhraní API pro katalog Learn, poznámky k verzi a články s nejčastějšími dotazy, které vám pomohou s vývojem.

Koncový bod rozhraní API

Rozhraní API katalogu Microsoft Learn je webové rozhraní API založené na REST, které vrací odpověď zakódovanou ve formátu JSON. Pokud chcete požádat o úplný katalog, odešlete požadavek GET na:

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

Poznámka:

Výše uvedený koncový bod je aktuálním koncovým bodem. Pokud používáte jiný, starší koncový bod, bude při onboardování fungovat podle očekávání, ale výhody přechodu na nový koncový bod vám poskytnou vylepšené funkce, jako jsou další parametry dotazu.

Parametry dotazů

Níže jsou uvedené parametry dotazu, které může požadavek obsahovat. Všechny jsou volitelné. Hodnoty parametrů dotazů musíte zakódovat s použitím kódování URL. Koncový bod můžete použít s žádným, jedním, některým nebo všemi těmito parametry.

Důležité

Pokud použijete více než jednu, bude dotaz vyhodnocen pomocí operátoru AND.

Jméno	Hodnota	Type	Požadováno	Příklad
národní prostředí	Jeden platný kód národního prostředí z podporovaného seznamu národních prostředí. Případná vrácená metadata budou v požadovaném národním prostředí. Pokud tento parametr není zadaný, `en-us` vrátí se odpověď.	řetězec	No	`?locale=en-us`
type	Čárkami oddělený seznam jednoho nebo více objektů nejvyšší úrovně obsahu nebo taxonomií, které v současné době poskytujeme v odpovědi na vrácení. Podporované hodnoty jsou: `modules`, `units`, , `learningPaths`, `certificationsappliedSkillscoursesmergedCertificationsexams`, `roleslevels`, `products`, . `subjects`	řetězec	No	`?type=modules,learningPaths`
Uid	Čárkami oddělený seznam jednoho nebo více platných ID jedinečného obsahu (uid) z dostupných typů obsahu. Poznámka: UID rozlišují malá a velká písmena.	řetězec	No	`?uid=learn.azure.intro-to-azure-fundamentals`
last_modified	Operátor a datetime pro filtrování podle data poslední změny objektů. Operátor zahrnuje `lt` (menší než), `lte` (menší než nebo rovno), `eq` (rovno), `gt` (větší než), `gte` (větší než nebo rovno). Pokud použijete tento parametr, operátor se použije jako `gte` výchozí, pokud není zadaný.	řetězec	No	`?last_modified=gte 2022-01-01`
Popularity	Operátor a hodnota pro filtrování podle hodnoty popularity (v rozsahu 0–1) objektů. Operátor zahrnuje `lt` (menší než), `lte` (menší než nebo rovno), `eq` (rovno), `gt` (větší než), `gte` (větší než nebo rovno). Pokud použijete tento parametr, operátor se použije jako `gte` výchozí, pokud není zadaný.	řetězec	No	`?popularity=gte 0.5`
úroveň	Čárkami oddělený seznam jedné nebo více úrovní, které máme aktuálně k dispozici (úplný seznam je v objektu úrovní odpovědi rozhraní API).	řetězec	No	`?level=beginner`
role	Čárkami oddělený seznam jedné nebo více rolí, které máme aktuálně k dispozici (úplný seznam je v objektu rolí odpovědi rozhraní API).	řetězec	No	`?role=developer`
product	Čárkami oddělený seznam jedné nebo více rolí, které máme aktuálně k dispozici (úplný seznam je v objektu produktů odpovědi rozhraní API). Rozhraní API nepodporuje hierarchii produktů, takže přidejte každý produkt do seznamu, který chcete zahrnout do dotazu.	řetězec	No	`?product=azure`
subject	Čárkami oddělený seznam jedné nebo více rolí, které máme aktuálně k dispozici (úplný seznam je v objektu předmětu odpovědi rozhraní API). Rozhraní API nepodporuje hierarchii předmětu, takže do seznamu, který chcete zahrnout do dotazu, přidejte všechny předměty.	řetězec	No	`?subject=cloud-computing`

Ukázkové dotazy

Níže uvedené dotazy jsou ukázky, které vám pomůžou získat představu o tom, co si můžete vyžádat a jak vytvořit požadavek.

Popis	Dotaz
Všechny položky v rozhraní API katalogu Learn	`https://learn.microsoft.com/api/catalog/`
Všechny španělské moduly	`https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules`
Všechny moduly s hodnocením popularity 0,9 nebo vyšší	`https://learn.microsoft.com/api/catalog/?type=modules&popularity>0.9`
Všechny objekty pro školení a certifikaci zabezpečení pro začátečníky	`https://learn.microsoft.com/api/catalog/?level=beginner&subject=security`
Všechny pokročilé moduly přístupnosti s skóre popularity nad 0,5 a aktualizovány za poslední měsíc	`https://learn.microsoft.com/api/catalog/?level=advanced&subject=accessibility&popularity>0.5&last_modified=gte 2022-10-01`

Odpověď rozhraní API

Služba může vracet následující stavové kódy HTTP.

Stavový kód	Popis
200	Úspěch Tělo odpovědi zahrnuje data s kódováním JSON.
400	Jeden z parametrů dotazu chybí nebo je neplatný.
404	Adresa URL nebyla na serveru nalezena.
500	Neočekávaná chyba serveru.
503	Služba je dočasně nedostupná.

Úspěšná odpověď bude obsahovat podrobnosti o všech modulech a studijních programech, jak je uvedeno dál.

Text odpovědi

Text úspěšné odpovědi se zakóduje ve formátu JSON a bude mít 12 oddílů:

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

Každé pole má jeden nebo více objektů s kódováním JSON, které obsahují data specifická pro danou část odpovědi.

modules je pole publikovaných modulů.
units: je pole publikovaných jednotek.
learningPaths je pole publikovaných studijních programů.
appliedSkills: je pole publikovaných použitých dovedností.
mergedCertifications: je pole publikovaných certifikací sloučených se zkouškami.
certifications: je pole publikovaných certifikací.
exams: je pole publikovaných zkoušek.
courses: je pole publikovaných školicích kurzů vedených instruktorem.
levels je pole možných úrovní cílových skupin.
products: je pole možných produktů a služeb zahrnutých v katalogu.
roles je pole možných pracovních náplní.
subjects: je pole možných značek předmětu.

Záznamy pro moduly

Každý záznam modulu bude mít následující formulář:

{
    "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://learn.microsoft.com/learn/achievements/principles-cloud-computing.svg",
    "social_image_url": "https://learn.microsoft.com/learn/achievements/principles-cloud-computing-social.png",
    "locale": "en-us",
    "last_modified": "2018-09-24T00:00:00Z",
    "url": "https://learn.microsoft.com/learn/modules/principles-cloud-computing",
    "firstUnitUrl": "https://learn.microsoft.com/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 o poli

Pole	Typ	Description
`summary`	řetězec	Řetězec, který poskytuje stručný popis modulu. Hodnota je vyjádřena jako značka odstavce HTML a souhrnem je její vnitřní text.
`levels`	pole řetězců	Seznam úrovní přidružených k tomuto modulu, které ukazují, kolik zkušeností s rolí je nezbytné k pochopení všech aspektů tohoto modulu. Podrobnosti o jednotkách lze odkazovat v záznamech na úrovni.
`roles`	pole řetězců	Seznam pracovních náplní, pro které je tento modul relevantní.
`products`	pole řetězců	Seznam relevantních produktů, které tento modul probírá. Podrobnosti o produktech lze odkazovat v záznamech produktů.
`subjects`	pole řetězců	Seznam relevantních předmětů, které tento studijní program popisuje.
`uid`	řetězec	Jedinečný identifikátor pro tento modul. Tato hodnota bude v rámci MS Learn jedinečná.
`type`	řetězec	Typ záznamu. Jeho hodnotou bude vždycky module.
`title`	řetězec	Název modulu v požadovaném národním prostředí (nebo v angličtině).
`duration_in_minutes`	integer	Průměrná doba, která je potřeba k dokončení tohoto modulu (v minutách).
`rating`	objekt	Obsahuje obojí `count`, což je počet lidí, kteří modul ohodnotili, a `average`agregace hodnocení, která bude 1-5.
`popularity`	double	Normalizovaná hodnota od 0 do 1 označující oblíbenost tohoto modulu.
`icon_url`	řetězec	Plně kvalifikovaná adresa URL obrázku SVG s 100x100, který představuje obrázek dosaženého modulu s průhledným pozadím.
`social_image_url`	řetězec	Plně kvalifikovaná adresa URL obrázku PNG, který představuje obrázek dosaženého modulu s obdélníkovým neprůhlhlým pozadím, které je vhodné pro prostředí sociálních médií nebo dlaždic. Pokud není pro tento modul k dispozici, tato vlastnost se v odpovědi nevrátí.
`locale`	řetězec	Jazyk, ve kterém jsou tato data JSON zapsaná. Touto hodnotou bude požadované národní prostředí, pokud je k dispozici. Pokud ne, bude to hodnota en-us.
`last_modified`	datum	Datum poslední hlavní revize tohoto modulu.
`url`	řetězec	Plně kvalifikovaná adresa URL modulu Learn v požadovaném národním prostředí.
`firstUnitUrl`	řetězec	Plně kvalifikovaná adresa URL na první lekci modulu Learn v požadovaném národním prostředí.
`units`	pole řetězců	Seznam id přidružených jednotek Podrobnosti o jednotkách lze odkazovat v záznamech jednotek.
`number_of_children`	integer	Počet stránek (jednotek), které tento modul obsahuje.

Záznamy jednotek

Každý záznam jednotky bude mít následující formulář:

{
    "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á přidruženou adresu URL, protože jednotky nejsou zapsány jako samostatný obsah. Tyto moduly mají být převzaty v určitém pořadí. Z tohoto důvodu zahrneme odkaz na stránku podrobností modulu a první lekci v záznamu modulu, aby uživatelé mohli začít tam a pokračovat v obsahu. Záznamy jednotek se ale dají použít k získání podrobností o jednotkách, které se mají zobrazit v prostředích LMS nebo jiných prostředích.

Podrobnosti o poli

Pole	Typ	Description
`uid`	řetězec	Jedinečný identifikátor pro tento modul. Tato hodnota bude v rámci MS Learn jedinečná.
`type`	řetězec	Typ záznamu. Hodnota bude vždy "jednotka".
`title`	řetězec	Název jednotky v požadovaném národním prostředí nebo angličtina v USA jako záložní.
`duration_in_minutes`	Doba trvání jednotky. Pokud přidáte všechny duration_in_minutes jednotek přidružených k jednotlivým modulům, získáte celkový čas modulu.
`locale`	řetězec	Jazyk, ve kterém jsou tato data JSON zapsaná. Touto hodnotou bude požadované národní prostředí, pokud je k dispozici. Pokud ne, bude to hodnota en-us.
`last_modified`	datum	Datum poslední hlavní revize tohoto modulu.

Záznamy pro studijní programy

Každý záznam studijního programu bude mít následující formulář:

{
    "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://learn.microsoft.com/learn/achievements/create-serverless-applications.svg",
    "social_image_url": "https://learn.microsoft.com/learn/achievements/create-serverless-applications-social.png",
    "locale": "en-us",
    "last_modified": "2018-12-27T00:00:00Z",
    "url": "https://learn.microsoft.com/learn/paths/create-serverless-applications",
    "firstModuleUrl": "https://learn.microsoft.com/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 o poli

Pole	Typ	Description
`summary`	řetězec	Řetězec, který poskytuje stručný popis studijního programu. Hodnota je vyjádřena jako značka odstavce HTML a souhrnem je její vnitřní text.
`levels`	pole řetězců	Seznam úrovní přidružených k tomuto studijnímu programu, který označuje, kolik zkušeností v této roli je nezbytné k pochopení všech aspektů tohoto studijního programu. Podrobnosti o jednotkách lze odkazovat v záznamech na úrovni.
`roles`	pole řetězců	Seznam relevantních pracovních náplní pro tento studijní program.
`products`	pole řetězců	Seznam relevantních produktů, které tento studijní program probírá. Podrobnosti o produktech lze odkazovat v záznamech produktů.
`subjects`	pole řetězců	Seznam relevantních předmětů, které tento studijní program popisuje.
`uid`	řetězec	Jedinečný identifikátor pro tento studijní program. Tato hodnota bude v rámci MS Learn jedinečná.
`type`	řetězec	Typ záznamu. Jeho hodnotou bude vždycky learningPath.
`title`	řetězec	Název studijního programu v požadovaném národním prostředí (nebo v angličtině).
`duration_in_minutes`	integer	Průměrná doba, která je potřeba k dokončení tohoto studijního programu (v minutách). Tato hodnota představuje součet příslušných hodnot všech zahrnutých modulů.
`rating`	objekt	Obsahuje obojí `count`, což je počet lidí, kteří ohodnotili studijní program, a `average`agregaci hodnocení, která bude 1–5.
`popularity`	double	Normalizovaná hodnota od 0 do 1 označující oblíbenost tohoto studijního programu.
`icon_url`	řetězec	Plně kvalifikovaná adresa URL obrázku SVG 100x100, který představuje studijní program.
`social_image_url`	řetězec	Plně kvalifikovaná adresa URL obrázku PNG, která představuje obrázek dosaženého studijního programu s obdélníkovým neprůhlhlým pozadím, které je vhodné pro prostředí sociálních médií nebo dlaždic. Pokud není pro tento modul k dispozici, tato vlastnost se v odpovědi nevrátí.
`locale`	řetězec	Jazyk, ve kterém jsou tato data JSON zapsaná. Touto hodnotou bude požadované národní prostředí, pokud je k dispozici. Pokud ne, bude to hodnota en-us.
`last_modified`	datum	Datum poslední hlavní revize tohoto studijního programu.
`url`	řetězec	Plně kvalifikovaná adresa URL studijního programu v rámci Microsoft Learn v požadovaném národním prostředí.
`firstModuleUrl`	řetězec	Plně kvalifikovaná adresa URL pro první modul studijního programu v rámci Microsoft Learn v požadovaném národním prostředí.
`modules`	pole řetězců	Seznam id přidružených modulů Podrobnosti o modulech lze odkazovat v záznamech modulu.
`number_of_children`	integer	Počet modulů, které tento studijní program obsahuje.

Použité záznamy dovedností

Každý záznam použité dovednosti bude mít následující formulář:

{
    "uid": "applied-skill.deploy-and-configure-azure-monitor",
    "locale": "en-us",
    "url": "https://learn.microsoft.com/en-us/credentials/applied-skills/deploy-and-configure-azure-monitor/?WT.mc_id=api_CatalogApi",
    "title": "Deploy and configure Azure Monitor",
    "summary": "<p>To earn this Microsoft Applied Skills credential, learners demonstrate the ability to deploy and configure monitoring for Azure infrastructure.</p>\n<p>Candidates for this assessment lab should be familiar with operating systems, networking, servers, and virtualization.</p>\n",
    "levels": [
        "intermediate"
    ],
    "roles": [
        "administrator"
    ],
    "products": [
        "azure-monitor",
        "azure-virtual-machines",
        "azure-virtual-network",
        "windows-server"
    ],
    "subjects": [
        "it-management-monitoring"
    ],
    "study_guide": [
        {
            "uid": "learn.wwl.deploy-configure-azure-monitor",
            "type": "learningPath"
        }
    ],
    "last_modified": "2023-10-25T17:07:00+00:00"
}

Podrobnosti o poli

Pole	Typ	Description
`uid`	řetězec	Jedinečný identifikátor pro tuto použitou dovednost – tato hodnota bude jedinečná ve všech ms Learn.
`locale`	řetězec	Jazyk, ve kterém jsou tato data JSON zapsaná. Touto hodnotou bude požadované národní prostředí, pokud je k dispozici. Pokud ne, bude to hodnota en-us.
`title`	řetězec	Název použité dovednosti v požadovaném národním prostředí nebo angličtina v USA jako záložní.
`summary`	řetězec	Souhrn použité dovednosti v požadovaném národním prostředí nebo angličtina v USA jako záložní.
`url`	řetězec	Plně kvalifikovaná adresa URL použité dovednosti v Microsoft Learn v požadovaném národním prostředí.
`icon_url`	řetězec	Plně kvalifikovaná adresa URL obrázku SVG 100x100, která představuje použitou dovednost (pokud je k dispozici, jinak není zahrnuta).
`levels`	pole řetězců	Seznam úrovní přidružených k této použité dovednosti.
`roles`	pole řetězců	Seznam relevantních pracovních rolí pro tuto použitou dovednost. Podrobnosti o rolích lze odkazovat v záznamech rolí.
`subjects`	pole řetězců	Seznam relevantních témat, které tato použitá dovednost pokrývá.
`study_guide`	pole objektů	Seznam přidruženého obsahu ke studiu pro tuto použitou dovednost. Podrobnosti o objektech lze odkazovat v přidružených záznamech.
`last_modified`	datum	Čas poslední změny použité dovednosti.

Sloučené záznamy certifikace

Každý sloučený certifikační záznam bude mít následující formulář:

{
    "uid": "certification.d365-functional-consultant-manufacturing",
    "title": "Microsoft Certified: Dynamics 365 Supply Chain Management, Manufacturing Functional Consultant Associate",
    "summary": "<div class=\"WARNING\">\n<p>Warning</p>\n<p>This certification retired on June 30, 2023. You can renew it for at least six months after the retirement date by completing the free online assessment available on the <a href=\"/credentials/certifications/d365-functional-consultant-manufacturing/renew\">certification renewal page</a>. <a href=\"https://aka.ms/BACertPortfolioUpdatesBlog\">Read the blog post</a>.</p>\n</div>\n<p>If you’re a functional consultant or a business user with a deep understanding of manufacturing industry standards, this certification might be for you. You also need experience configuring and implementing Dynamics 365 Supply Chain Management to meet the needs of your organization. Supply chain management, manufacturing functional consultants are key resources who work with developers, solution architects, project managers, and functional consultants in finance, commerce, and supply chain.</p>\n<p>If you need more experience before you try to earn this certification, here are some suggestions:</p>\n<ul>\n<li>Study the supply chain management and supply chain management, manufacturing modules on Microsoft Learn, and complete more hands-on practice.</li>\n<li>Sign up for an instructor-led training course that covers the MB-300 or MB-320 track.</li>\n<li>Take part in the community at <a href=\"https://community.dynamics.com/\">community.dynamics.com</a>, or join a user group.</li>\n<li>Shadow a manufacturing functional consultant in a manufacturing workstream.</li>\n<li>Get a mentor, tour manufacturing lines, and learn how things are made.</li>\n<li>Ask questions, and learn from experts and customers.</li>\n</ul>\n",
    "url": "https://learn.microsoft.com/en-us/credentials/certifications/d365-functional-consultant-manufacturing/?WT.mc_id=api_CatalogApi",
    "icon_url": "https://learn.microsoft.com/en-us/media/learn/certification/badges/microsoft-certified-associate-badge.svg",
    "last_modified": "2023-09-19T00:47:00+00:00",
    "type": "cert",
    "certification_type": "role-based",
    "products": [
        "dynamics-365",
        "dynamics-finance"
    ],
    "levels": [
        "intermediate"
    ],
    "roles": [
        "functional-consultant"
    ],
    "subjects": [],
    "renewal_frequency_in_days": 0,
    "prerequisites": [],
    "skills": [
        "Describe finance and operations apps, and extend apps by using Microsoft Power Platform technologies",
        "Configure administrative features and workflows",
        "Manage finance and operations data",
        "Validate and support solutions",
        "Configure Dynamics 365 Supply Chain Management, Manufacturing",
        "Manage manufacturing processes",
        "Implement master planning for production",
        "Implement other manufacturing features"
    ],
    "recommendation_list": [],
    "study_guide": [],
    "exam_duration_in_minutes": 0,
    "locales": [],
    "providers": [],
    "career_paths": []
}

Podrobnosti o poli

Pole	Typ	Description
`uid`	řetězec	Jedinečný identifikátor pro tuto certifikaci – tato hodnota bude jedinečná ve všech ms Learn.
`title`	řetězec	Název certifikace v požadovaném národním prostředí nebo angličtina v USA jako záložní.
`summary`	řetězec	Souhrn certifikace v požadovaném národním prostředí nebo angličtina v USA jako záložní.
`url`	řetězec	Plně kvalifikovaná adresa URL certifikace v Microsoft Learn v požadovaném národním prostředí.
`icon_url`	řetězec	Plně kvalifikovaná adresa URL image SVG 100x100, která představuje certifikaci.
`last_modified`	datum	Čas poslední změny této certifikace.
`type`	řetězec	Typ záznamu. Hodnota bude vždy "cert".
`certification_type`	řetězec	Typ certifikace. Možné hodnoty jsou "fundamentals", 'mce', 'mcsa', 'mcsd', 'mcse', 'mos', 'mta', 'role-based', 'specialty'.
`products`	pole řetězců	Seznam relevantních produktů, na které se tato certifikace vztahuje. Podrobnosti o produktech lze odkazovat v záznamech produktů.
`levels`	pole řetězců	Seznam úrovní spojených s touto certifikací, které ukazují, kolik zkušeností v této roli je nezbytné k pochopení všech aspektů zkoušek této certifikace. Podrobnosti o jednotkách lze odkazovat v záznamech na úrovni.
`roles`	pole řetězců	Seznam relevantních rolí úloh pro tuto certifikaci. Podrobnosti o rolích lze odkazovat v záznamech rolí.
`subjects`	pole řetězců	Seznam relevantních subjektů, na které se tato certifikace vztahuje.
`renewal_frequency_in_days`	integer	Počet dní před vypršením platnosti této certifikace a je potřeba ho obnovit. Pokud je hodnota 0, platnost certifikace nevyprší.
`prerequisites`	pole řetězců	Seznam doporučených požadavků pro získání této certifikace Podrobnosti o certifikacích lze odkazovat v záznamech certifikace.
`skills`	pole řetězců	Seznam dovedností měřených na zkoušce požadované pro tuto certifikaci.
`recommendation_list`	pole řetězců	Seznam doporučených položek souvisejících s touto certifikací
`study_guide`	pole objektů	Seznam přidruženého obsahu ke studiu pro tuto certifikaci. Podrobnosti o objektech lze odkazovat v přidružených záznamech.
`exam_duration_in_minutes`	integer	Počet minut přidělených k dokončení zkoušky.
`locales`	pole řetězců	Seznam jazyků, ve které se tato certifikace nabízí.
`providers`	pole objektů	Seznam poskytovatelů pro tuto certifikaci. Tento typ popisuje poskytovatele a plně kvalifikovanou adresu URL s odkazem na naplánování zkoušky u poskytovatele.
`career_paths`	pole objektů	Seznam kariérových cest pro tuto certifikaci.

Poznámka:

Certifikace, které vyžadují pouze jednu zkoušku, budou vráceny jako součást této sloučenéCertifications vlastnost.

Záznamy certifikace

Každý záznam certifikace bude mít následující formulář:

{
    "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://learn.microsoft.com/cert-exam-sandbox/cert/?WT.mc_id=api_CatalogApi",
    "icon_url": "https://learn.microsoft.com/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 o poli

Pole	Typ	Description
`uid`	řetězec	Jedinečný identifikátor pro tuto certifikaci – tato hodnota bude jedinečná ve všech ms Learn.
`title`	řetězec	Název certifikace v požadovaném národním prostředí nebo angličtina v USA jako záložní.
`subtitle`	řetězec	Podnadpis certifikace v požadovaném národním prostředí nebo angličtina v USA jako záložní.
`url`	řetězec	Plně kvalifikovaná adresa URL certifikace v Microsoft Learn v požadovaném národním prostředí.
`icon_url`	řetězec	Plně kvalifikovaná adresa URL image SVG 100x100, která představuje certifikaci.
`type`	řetězec	Typ záznamu. Hodnota bude vždy "cert".
`certification_type`	řetězec	Typ certifikace. Možné hodnoty jsou "fundamentals", 'mce', 'mcsa', 'mcsd', 'mcse', 'mos', 'mta', 'role-based', 'specialty'.
`exams`	pole řetězců	Seznam přidružených zkoušek požadovaných pro tuto certifikaci. Podrobnosti o jednotkách lze odkazovat v certifikačních záznamech.
`levels`	pole řetězců	Seznam úrovní spojených s touto certifikací, které ukazují, kolik zkušeností v této roli je nezbytné k pochopení všech aspektů zkoušek této certifikace. Podrobnosti o jednotkách lze odkazovat v záznamech na úrovni.
`roles`	pole řetězců	Seznam relevantních rolí úloh pro tuto certifikaci. Podrobnosti o rolích lze odkazovat v záznamech rolí.
`study_guide`	pole objektů	Seznam přidruženého obsahu ke studiu pro tuto certifikaci. Podrobnosti o objektech lze odkazovat v přidružených záznamech.

Poznámka:

Certifikace vyžadující více než jednu zkoušku budou v tomto záznamu certifikace odkazující na pole zkoušek.

Záznamy zkoušky

Každý záznam zkoušky bude mít následující formulář:

{
    "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://learn.microsoft.com/cert-exam-sandbox/exam/77-881/?WT.mc_id=api_CatalogApi",
    "icon_url": "https://learn.microsoft.com/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&amp;utm_medium=certpage&amp;utm_campaign=msofficialpractice",
    "practice_assessment_url": "https://learn.microsoft.com/en-us/certifications/exams/{exam}/practice/assessment?assessment-type=practice&assessmentId={assessmentId}",
    "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 o poli

Pole	Typ	Description
`uid`	řetězec	Jedinečný identifikátor pro tuto zkoušku – tato hodnota bude jedinečná ve všech ms Learn.
`title`	řetězec	Název zkoušky v požadovaném národním prostředí nebo v angličtině v USA jako záložní.
`subtitle`	řetězec	Podnadpis zkoušky v požadovaném národním prostředí nebo angličtina v USA jako záložní.
`display_name`	řetězec	Zobrazovaný název zkoušky v požadovaném národním prostředí nebo angličtina v USA jako záložní.
`url`	řetězec	Plně kvalifikovaná adresa URL pro zkoušku v Microsoft Learn v požadovaném národním prostředí.
`icon_url`	řetězec	Plně kvalifikovaná adresa URL obrázku SVG 100x100, který představuje zkoušku.
`pdf_download_url`	řetězec	Plně kvalifikovaná adresa URL souboru PDF s přehledem dovedností měřených touto zkouškou.
`practice_test_url`	řetězec	Plně kvalifikovaná adresa URL k praktickému testu přidruženému ke zkoušce.
`practice_assessment_url`	řetězec	Plně kvalifikovaná adresa URL k vyhodnocení bezplatné praxe přidružené ke zkoušce.
`locales`	pole řetězců	Seznam jazyků, ve které se tato zkouška nabízí.
`type`	řetězec	Typ záznamu. Hodnota bude vždy "zkouška".
`courses`	pole řetězců	Seznam přidružených identifikátorů identifikátorů kurzů Podrobnosti o kurzech lze odkazovat v záznamech kurzu.
`levels`	pole řetězců	Seznam úrovní spojených s touto zkouškou, které ukazují, kolik zkušeností v roli je nezbytné k pochopení všech aspektů této zkoušky. Podrobnosti o jednotkách lze odkazovat v záznamech na úrovni.
`roles`	pole řetězců	Seznam relevantních rolí úloh pro tuto zkoušku Podrobnosti o rolích lze odkazovat v záznamech rolí.
`products`	pole řetězců	Seznam relevantních produktů, na které se tato zkouška vztahuje. Podrobnosti o produktech lze odkazovat v záznamech produktů.
`providers`	pole objektů	Seznam poskytovatelů pro tuto zkoušku Tento typ popisuje poskytovatele a plně kvalifikovanou adresu URL s odkazem na naplánování zkoušky u poskytovatele.
`study_guide`	pole objektů	Seznam souvisejícího obsahu ke studiu pro tuto zkoušku. Podrobnosti o objektech lze odkazovat v přidružených záznamech.

Záznamy kurzů vedené instruktorem

Každý záznam kurzu bude mít následující formulář:

{
    "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://learn.microsoft.com/cert-exam-sandbox/course/mb-230t01/?WT.mc_id=api_CatalogApi",
    "icon_url": "https://learn.microsoft.com/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 o poli

Pole	Typ	Description
`uid`	řetězec	Jedinečný identifikátor tohoto kurzu vedeného instruktorem – tato hodnota bude jedinečná pro všechny ms Learn.
`course_number`	řetězec	Identifikátor čísla kurzu vedeného instruktorem.
`title`	řetězec	Název kurzu vedeného instruktorem v požadovaném národním prostředí nebo v americké angličtině jako záložní kurz.
`summary`	řetězec	Řetězec s krátkým popisem instruktora. Hodnota je vyjádřena jako značka odstavce HTML a souhrnem je její vnitřní text.
`duration_in_hours`	integer	Průměrná doba, po které tento kurz vedl instruktorem, trvá dokončení v hodinách.
`url`	řetězec	Plně kvalifikovaná adresa URL na stránku podrobností kurzu vedeného instruktorem v Microsoft Learn v požadovaném národním prostředí.
`icon_url`	řetězec	Plně kvalifikovaná adresa URL obrázku SVG s 100x100, který představuje úspěch kurzu vedeného instruktorem.
`locales`	pole řetězců	Seznam jazyků, ve které je tento kurz vedený instruktorem, se oficiálně nabízí. Další jazyky mohou být podporovány studijními partnery.
`type`	řetězec	Typ záznamu. Hodnota bude vždy "kurz" pro kurzy řízené instruktorem.
`certification`	řetězec	Certifikace přidružená k kurzu vedenému instruktorem.
`exam`	řetězec	Zkouška spojená s kurzem vedeným instruktorem.
`levels`	pole řetězců	Seznam úrovní spojených s tímto kurzem vedeným instruktorem, který označuje, kolik zkušeností v této roli je nezbytné k pochopení všech aspektů tohoto kurzu. Podrobnosti o jednotkách lze odkazovat v záznamech na úrovni.
`study_guide`	pole objektů	Plně kvalifikovaná adresa URL souboru PDF s popisem dovedností měřených touto certifikací.

Záznamy o úrovních, produktech, rolích a předmětech

Kolekce levels, products, rolesa subjects poskytují popisné názvy hodnot použitých v modulu a dat studijního programu. Všechny čtyři kolekce mají stejný tvar:

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

Bude id odpovídat hodnotám pro úrovně, produkty, role a předměty zahrnuté v dalších položkách katalogu. Přidružený parametr name poskytuje odpovídající název položky v angličtině. Pole children je volitelné a umožňuje použití hierarchické struktury pro hodnoty s relacemi podřízenosti, jako jsou třeba produkty.

Tady je například sada 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"
        },
        ...
    ]
}

Tady je příklad sady produktů s podřízenými součástmi, které poskytují konkrétnější kategorii produktů.

{
    ...
    "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"
        },
        ...
    ]
}

Ukázky kódu

Existuje mnoho způsobů, jak volat rozhraní API katalogu Learn, ale níže uvedené ukázky kódu jsou příklady, jak se dá použít.

jQuery

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

.NET a 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://learn.microsoft.com/api/learn/catalog?locale=en-us");
dynamic parsedJson = JsonConvert.DeserializeObject(response);
JsonConvert.SerializeObject(response, Formatting.Indented);
return Convert.ToString(response);
}

PHP s využitím rozšíření cURL

<?php 

// From URL to get webpage contents. 
$url = "https://learn.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 s využitím knihovny 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://learn.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)

Další kroky

Projděte si následující zdroje informací, které vám pomůžou na cestě vývoje:

Referenční dokumentace k rozhraní API katalogu Microsoft Learn

Koncový bod rozhraní API

Parametry dotazů

Ukázkové dotazy

Odpověď rozhraní API

Text odpovědi

Záznamy pro moduly

Podrobnosti o poli

Záznamy jednotek

Podrobnosti o poli

Záznamy pro studijní programy

Podrobnosti o poli

Použité záznamy dovedností

Podrobnosti o poli

Sloučené záznamy certifikace

Podrobnosti o poli

Záznamy certifikace

Podrobnosti o poli

Záznamy zkoušky

Podrobnosti o poli

Záznamy kurzů vedené instruktorem

Podrobnosti o poli

Záznamy o úrovních, produktech, rolích a předmětech

Ukázky kódu

jQuery

.NET a C#

PHP s využitím rozšíření cURL

PYTHON 3 s využitím knihovny requests

Další kroky

Další materiály