Udostępnij za pośrednictwem


Dokumentacja dla deweloperów interfejsu API wykazu usługi Microsoft Learn

Ten artykuł zawiera informacje dla deweloperów i osób żądających implementujących interfejs API wykazu usługi Microsoft Learn. Zalecamy również zapoznanie się z najlepszymi rozwiązaniami dotyczącymi interfejsu API wykazu platformy Learn, informacjami o wersji i artykułami z często zadawanymi pytaniami, które umożliwiają obsługę programowania.

Punkt końcowy interfejsu API

Interfejs API wykazu usługi Microsoft Learn to internetowy interfejs API oparty na protokole REST, który zwraca odpowiedź zakodowaną w formacie JSON. Aby zażądać pełnego wykazu, wyślij żądanie GET do:

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

Uwaga

Punkt końcowy wymieniony powyżej jest bieżącym punktem końcowym. Jeśli używasz innego, starszego punktu końcowego, nadal będzie działać zgodnie z oczekiwaniami podczas dołączania, ale korzyści wynikające z przełączenia do nowego punktu końcowego są takie, że zapewni rozszerzone funkcje, takie jak dodatkowe parametry zapytania.

Parametry zapytań

Poniżej przedstawiono parametry zapytania, które może zawierać żądanie. Wszystkie są opcjonalne. Wartości parametrów zapytania należy zakodować w adresie URL. Możesz użyć punktu końcowego z brakiem, jednym, niektórymi lub wszystkimi tymi parametrami.

Ważne

Jeśli używasz więcej niż jednego, zapytanie zostanie ocenione przy użyciu operatora AND.

Nazwa/nazwisko Wartość Type Wymagania Przykład
ustawienia regionalne Pojedynczy prawidłowy kod ustawień regionalnych z obsługiwanej listy ustawień regionalnych. Zwrócone metadane będą miały żądane ustawienia regionalne, o ile będą dostępne. Jeśli ten parametr nie zostanie podany, en-us odpowiedź zostanie zwrócona. string Nie ?locale=en-us
type Rozdzielana przecinkami lista co najmniej jednej zawartości najwyższego poziomu lub obiektów taksonomii, które obecnie udostępniamy w odpowiedzi na zwrócenie. Obsługiwane wartości to: modules, unitsproductslearningPathsroleslevelscertificationsappliedSkillsmergedCertificationsexamscourses. subjects string Nie ?type=modules,learningPaths
Identyfikator UID Rozdzielona przecinkami lista co najmniej jednego prawidłowego identyfikatora unikatowego identyfikatora zawartości (uid) z dostępnych typów zawartości. Uwaga: w identyfikatorach uid jest rozróżniana wielkość liter. string Nie ?uid=learn.azure.intro-to-azure-fundamentals
last_modified Operator i data/godzina filtrowania według daty ostatniej modyfikacji obiektów. Operator zawiera lt (mniejsze niż), lte (mniejsze lub równe), eq (równe), (większe niż), gtgte (większe lub równe). Jeśli używasz tego parametru, operator będzie domyślnie ustawiony, gte jeśli nie zostanie określony. string Nie ?last_modified=gte 2022-01-01
Popularność Operator i wartość do filtrowania według wartości popularności (w zakresie od 0 do 1) obiektów. Operator zawiera lt (mniejsze niż), lte (mniejsze lub równe), eq (równe), (większe niż), gtgte (większe lub równe). Jeśli używasz tego parametru, operator będzie domyślnie ustawiony, gte jeśli nie zostanie określony. string Nie ?popularity=gte 0.5
poziom Rozdzielona przecinkami lista co najmniej jednego z aktualnie dostępnych poziomów (pełna lista znajduje się w obiekcie poziomów odpowiedzi interfejsu API). string Nie ?level=beginner
role Rozdzielona przecinkami lista co najmniej jednej z aktualnie dostępnych ról (pełna lista znajduje się w obiekcie ról odpowiedzi interfejsu API). string Nie ?role=developer
product Rozdzielona przecinkami lista co najmniej jednej z aktualnie dostępnych ról (pełna lista znajduje się w obiekcie products odpowiedzi interfejsu API). Interfejs API nie obsługuje hierarchii produktów, dlatego dodaj każdy produkt do listy, którą chcesz uwzględnić w zapytaniu. string Nie ?product=azure
subject Rozdzielona przecinkami lista co najmniej jednej z aktualnie dostępnych ról (pełna lista znajduje się w obiekcie podmiotów odpowiedzi interfejsu API). Interfejs API nie obsługuje hierarchii tematów, dlatego dodaj każdy temat do listy, którą chcesz uwzględnić w zapytaniu. string Nie ?subject=cloud-computing

Przykładowe zapytania

Zapytania wymienione poniżej to przykłady, które ułatwiają uzyskanie informacji o tym, czego możesz zażądać i jak utworzyć żądanie.

opis Zapytanie
Wszystkie elementy w interfejsie API wykazu platformy Learn https://learn.microsoft.com/api/catalog/
Wszystkie moduły hiszpańskie https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules
Wszystkie moduły z oceną popularności na poziomie 0,9 lub wyższym https://learn.microsoft.com/api/catalog/?type=modules&popularity>0.9
Wszystkie obiekty szkoleń i certyfikacji zabezpieczeń dla początkujących https://learn.microsoft.com/api/catalog/?level=beginner&subject=security
Wszystkie zaawansowane moduły ułatwień dostępu z wynikiem popularności powyżej 0,5 i zaktualizowane w ostatnim miesiącu https://learn.microsoft.com/api/catalog/?level=advanced&subject=accessibility&popularity>0.5&last_modified=gte 2022-10-01

Odpowiedź interfejsu API

Usługa może zwracać następujące kody stanu HTTP.

Kod stanu opis
200 Powodzenie. Treść odpowiedzi zawiera dane zakodowane w formacie JSON.
400 Brakuje jednego z parametrów zapytania lub jest on nieprawidłowy.
404 Nie znaleziono adresu URL na serwerze.
500 Nieoczekiwany błąd serwera.
503 Usługa jest tymczasowo niedostępna.

Pomyślna odpowiedź będzie zawierać szczegółowe informacje o wszystkich modułach i ścieżkach szkoleniowych, jak pokazano poniżej.

Treść odpowiedzi

Treść pomyślnej odpowiedzi zostanie zakodowana w formacie JSON i będzie zawierać 12 sekcji:

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

Każda tablica zawiera jeden lub więcej obiektów zakodowanych w formacie JSON z danymi specyficznymi dla danej sekcji odpowiedzi.

  1. modules to tablica opublikowanych modułów.
  2. units: jest tablicą opublikowanych jednostek.
  3. learningPaths to tablica opublikowanych ścieżek szkoleniowych.
  4. appliedSkills: to tablica opublikowanych umiejętności stosowanych.
  5. mergedCertifications: to tablica opublikowanych certyfikatów scalonych z egzaminami.
  6. certifications: to tablica opublikowanych certyfikatów.
  7. exams: to tablica opublikowanych egzaminów.
  8. courses: to szereg opublikowanych kursów szkoleniowych prowadzonych przez instruktora.
  9. levels to tablica możliwych poziomów odbiorców.
  10. products: to tablica możliwych produktów i usług objętych wykazem.
  11. roles to tablica możliwych ról zadań.
  12. subjects: to tablica możliwych tagów podmiotów.

Rekordy modułów

Rekordy modułów

Każdy rekord modułu będzie miał następującą postać:

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

Szczegóły pola

Pole Typ opis
summary string Ciąg, który zawiera krótki opis modułu. Wartość jest wyrażona jako tag akapitu HTML, w którym tekst wewnętrzny jest podsumowaniem.
levels tablica ciągów Lista poziomów skojarzonych z tym modułem, które wskazują, ile doświadczenia w roli jest niezbędne do zrozumienia wszystkich aspektów tego modułu. Szczegółowe informacje o jednostkach można znaleźć w rekordach poziomu.
roles tablica ciągów Lista ról zadań, dla których ten moduł jest odpowiedni.
products tablica ciągów Lista odpowiednich produktów, których dotyczy ten moduł. Szczegółowe informacje o produktach można znaleźć w rekordach produktu.
subjects tablica ciągów Lista odpowiednich tematów, które obejmuje ta ścieżka szkoleniowa.
uid string Unikatowy identyfikator tego modułu — ta wartość będzie unikatowa w całej usłudze MS Learn.
type string Typ rekordu. Wartość będzie zawsze równa „module”.
title string Tytuł modułu dla żądanych ustawień regionalnych lub w języku angielskim (Stany Zjednoczone) jako rezerwowy.
duration_in_minutes integer Średni czas potrzebny na ukończenie tego modułu (w minutach).
rating obiekt Zawiera wartość count, czyli liczbę osób, które oceniły moduł, oraz averageagregację klasyfikacji, która będzie wynosić od 1 do 5
popularity double Znormalizowana wartość od 0 do 1, która wskazuje popularność modułu
icon_url string W pełni kwalifikowany adres URL do obrazu SVG 100x100, który reprezentuje obraz osiągnięcia modułu z przezroczystym tłem.
social_image_url string W pełni kwalifikowany adres URL obrazu PNG, który reprezentuje obraz osiągnięcia modułu z prostokątnym nieprzezroczystym tłem, dostosowanym do środowisk mediów społecznościowych lub kafelków. Jeśli nie jest on dostępny dla tego modułu, ta właściwość nie zostanie zwrócona w odpowiedzi.
locale string Język, w którym napisane są dane w formacie JSON. Ta wartość będzie równa żądanym ustawieniom regionalnym, jeśli będą dostępne. W przeciwnym razie będzie to „en-us”.
last_modified data Czas ostatniej istotnej poprawki tego modułu.
url string W pełni kwalifikowany adres URL modułu Learn w żądanych ustawieniach regionalnych.
firstUnitUrl string W pełni kwalifikowany adres URL do pierwszej lekcji modułu Learn w żądanych ustawieniach regionalnych.
units tablica ciągów Lista skojarzonych identyfikatorów UID jednostki. Szczegółowe informacje o jednostkach można znaleźć w rekordach lekcji.
number_of_children integer Liczba stron (lekcji) w tym module.

Rekordy jednostek

Każdy rekord jednostki będzie miał następującą formę:

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

Uwaga

Rekord jednostki nie ma skojarzonego adresu URL, ponieważ jednostki nie są zapisywane jako zawartość autonomiczna. Są one przeznaczone do wykonania w określonej kolejności modułu. Z tego powodu dołączymy link do strony szczegółów modułu i pierwszą jednostkę w rekordzie modułu, aby umożliwić użytkownikom rozpoczęcie pracy i kontynuowanie zawartości. Jednak rekordy jednostek mogą służyć do uzyskiwania szczegółowych informacji o jednostkach do wyświetlania w systemach LMSes lub innych środowiskach.

Szczegóły pola

Pole Typ opis
uid string Unikatowy identyfikator tego modułu — ta wartość będzie unikatowa w całej usłudze MS Learn.
type string Typ rekordu. Wartość będzie zawsze mieć wartość "unit".
title string Tytuł lekcji w żądanych ustawieniach regionalnych lub angielski w Stanach Zjednoczonych jako rezerwowy.
duration_in_minutes Czas trwania lekcji. Jeśli dodasz wszystkie duration_in_minutes jednostek skojarzonych z każdym modułem, uzyskasz łączny czas modułu.
locale string Język, w którym napisane są dane w formacie JSON. Ta wartość będzie równa żądanym ustawieniom regionalnym, jeśli będą dostępne. W przeciwnym razie będzie to „en-us”.
last_modified data Czas ostatniej istotnej poprawki tego modułu.

Rekordy ścieżek szkoleniowych

Każdy rekord ścieżki szkoleniowej będzie miał następującą formę:

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

Szczegóły pola

Pole Typ opis
summary string Ciąg, który zawiera krótki opis ścieżki szkoleniowej. Wartość jest wyrażona jako tag akapitu HTML, w którym tekst wewnętrzny jest podsumowaniem.
levels tablica ciągów Lista poziomów skojarzonych z tą ścieżką szkoleniową, która wskazuje, ile doświadczenia w roli jest niezbędne do zrozumienia wszystkich aspektów tej ścieżki szkoleniowej. Szczegółowe informacje o jednostkach można znaleźć w rekordach poziomu.
roles tablica ciągów Lista odpowiednich ról zadań dla tej ścieżki szkoleniowej.
products tablica ciągów Lista odpowiednich produktów, których dotyczy ta ścieżka szkoleniowa. Szczegółowe informacje o produktach można znaleźć w rekordach produktu.
subjects tablica ciągów Lista odpowiednich tematów, które obejmuje ta ścieżka szkoleniowa.
uid string Unikatowy identyfikator tej ścieżki szkoleniowej — ta wartość będzie unikatowa w całej usłudze MS Learn.
type string Typ rekordu. Wartość będzie zawsze równa „learningPath”.
title string Tytuł ścieżki szkoleniowej dla żądanych ustawień regionalnych lub w języku angielskim (Stany Zjednoczone) jako rezerwowy.
duration_in_minutes integer Średni czas potrzebny na ukończenie tej ścieżki szkoleniowej (w minutach). Ta wartość to suma danych ze wszystkich zawartych modułów.
rating obiekt Zawiera wartość count, czyli liczbę osób, które oceniły ścieżkę szkoleniową, oraz averageagregację ocen, które będą wynosić od 1 do 5
popularity double Znormalizowana wartość od 0 do 1, która wskazuje popularność ścieżki szkoleniowej
icon_url string W pełni kwalifikowany adres URL do obrazu SVG 100x100, który reprezentuje ścieżkę szkoleniową.
social_image_url string W pełni kwalifikowany adres URL obrazu PNG, który reprezentuje obraz osiągnięcia ścieżki szkoleniowej z prostokątnym nieprzezroczystym tłem, dostosowanym do środowisk mediów społecznościowych lub kafelków. Jeśli nie jest on dostępny dla tego modułu, ta właściwość nie zostanie zwrócona w odpowiedzi.
locale string Język, w którym napisane są dane w formacie JSON. Ta wartość będzie równa żądanym ustawieniom regionalnym, jeśli będą dostępne. W przeciwnym razie będzie to „en-us”.
last_modified data Czas ostatniej zmiany tej ścieżki szkoleniowej.
url string W pełni kwalifikowany adres URL do ścieżki szkoleniowej w usłudze Microsoft Learn dla żądanych ustawień regionalnych.
firstModuleUrl string W pełni kwalifikowany adres URL pierwszego modułu ścieżki szkoleniowej w usłudze Microsoft Learn dla żądanych ustawień regionalnych.
modules tablica ciągów Lista skojarzonych identyfikatorów użytkownika modułu. Szczegółowe informacje o modułach można znaleźć w rekordach modułu.
number_of_children integer Liczba modułów zawartych w tej ścieżce szkoleniowej.

Zastosowane rekordy umiejętności

Każdy rekord Zastosowane umiejętności będzie miał następującą formę:

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

Szczegóły pola

Pole Typ opis
uid string Unikatowy identyfikator dla tej zastosowanej umiejętności — ta wartość będzie unikatowa we wszystkich środowiskach MS Learn.
locale string Język, w którym napisane są dane w formacie JSON. Ta wartość będzie równa żądanym ustawieniom regionalnym, jeśli będą dostępne. W przeciwnym razie będzie to „en-us”.
title string Tytuł zastosowanej umiejętności w żądanych ustawieniach regionalnych lub angielski w Stanach Zjednoczonych jako rezerwowy.
summary string Podsumowanie zastosowanej umiejętności w żądanych ustawieniach regionalnych lub angielski usa jako rezerwowy.
url string W pełni kwalifikowany adres URL do zastosowanej umiejętności w środowisku Microsoft Learn w żądanych ustawieniach regionalnych.
icon_url string W pełni kwalifikowany adres URL do obrazu SVG 100x100, który reprezentuje zastosowaną umiejętność (jeśli jest dostępna, w przeciwnym razie nie jest uwzględniona).
levels tablica ciągów Lista poziomów skojarzonych z tą zastosowaną umiejętnością.
roles tablica ciągów Lista odpowiednich ról zadań dla tej zastosowanej umiejętności. Szczegółowe informacje o rolach można odwoływać się do rekordów ról.
subjects tablica ciągów Lista odpowiednich tematów, które obejmuje ta zastosowana umiejętność.
study_guide tablica obiektów Lista skojarzonej zawartości do nauki dla tej zastosowanej umiejętności. Szczegółowe informacje o obiektach można odwołać w skojarzonych rekordach.
last_modified data Ostatni raz ta zastosowana umiejętność została zmieniona.

Scalone rekordy certyfikacji

Każdy scalony rekord certyfikacji będzie miał następującą formę:

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

Szczegóły pola

Pole Typ opis
uid string Unikatowy identyfikator tego certyfikatu — ta wartość będzie unikatowa we wszystkich środowiskach MS Learn.
title string Tytuł certyfikacji w żądanych ustawieniach regionalnych lub angielski w Stanach Zjednoczonych jako rezerwowy.
summary string Podsumowanie certyfikatu w żądanych ustawieniach regionalnych lub angielski usa jako rezerwowy.
url string W pełni kwalifikowany adres URL certyfikatu w środowisku Microsoft Learn w żądanych ustawieniach regionalnych.
icon_url string W pełni kwalifikowany adres URL do obrazu SVG o rozmiarze 100x100, który reprezentuje certyfikację.
last_modified data Ostatni raz ten certyfikat został zmieniony.
type string Typ rekordu. Wartość będzie zawsze mieć wartość "cert".
certification_type string Typ certyfikacji. Możliwe wartości to "fundamentals", "mce", "mcsa", "mcsd", "mcse", "mos", "mta", "role-based", "specialty".
products tablica ciągów Lista odpowiednich produktów objętych tą certyfikacją. Szczegółowe informacje o produktach można znaleźć w rekordach produktu.
levels tablica ciągów Lista poziomów skojarzonych z tym certyfikatem, które wskazują, ile doświadczenia w roli jest konieczne, aby zrozumieć wszystkie aspekty egzaminów tego certyfikatu. Szczegółowe informacje o jednostkach można znaleźć w rekordach poziomu.
roles tablica ciągów Lista odpowiednich ról zadań dla tego certyfikatu. Szczegółowe informacje o rolach można odwoływać się do rekordów ról.
subjects tablica ciągów Lista odpowiednich podmiotów, które obejmują ten certyfikat.
renewal_frequency_in_days integer Liczba dni przed wygaśnięciem tego certyfikatu i musi zostać odnowiona. Jeśli wartość to 0, certyfikacja nie wygaśnie.
prerequisites tablica ciągów Lista zalecanych wymagań wstępnych do zdobycia tego certyfikatu. Szczegółowe informacje o certyfikatach można znaleźć w rekordach certyfikacji.
skills tablica ciągów Lista umiejętności mierzonych na egzaminie wymaganym do tego certyfikatu.
recommendation_list tablica ciągów Lista zalecanych elementów związanych z tym certyfikatem.
study_guide tablica obiektów Lista skojarzonej zawartości do badania dla tego certyfikatu. Szczegółowe informacje o obiektach można odwołać w skojarzonych rekordach.
exam_duration_in_minutes integer Liczba minut przydzielonych do ukończenia egzaminu.
locales tablica ciągów Lista języków, w których jest oferowana ta certyfikacja.
providers tablica obiektów Lista dostawców dla tego certyfikatu. Typ zawiera opis dostawcy i w pełni kwalifikowanego adresu URL z linkiem umożliwiającym zaplanowanie egzaminu u dostawcy.
career_paths tablica obiektów Lista ścieżek kariery dla tego certyfikatu.

Uwaga

Certyfikaty, które wymagają tylko jednego egzaminu, zostaną zwrócone w ramach tej scalonej właściwościCertifications.

Rekordy certyfikacji

Każdy rekord certyfikacji będzie miał następującą formę:

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

Szczegóły pola

Pole Typ opis
uid string Unikatowy identyfikator tego certyfikatu — ta wartość będzie unikatowa we wszystkich środowiskach MS Learn.
title string Tytuł certyfikacji w żądanych ustawieniach regionalnych lub angielski w Stanach Zjednoczonych jako rezerwowy.
subtitle string Podtytuł certyfikacji w żądanych ustawieniach regionalnych lub angielski w Stanach Zjednoczonych jako rezerwowy.
url string W pełni kwalifikowany adres URL certyfikatu w środowisku Microsoft Learn w żądanych ustawieniach regionalnych.
icon_url string W pełni kwalifikowany adres URL do obrazu SVG o rozmiarze 100x100, który reprezentuje certyfikację.
type string Typ rekordu. Wartość będzie zawsze mieć wartość "cert".
certification_type string Typ certyfikacji. Możliwe wartości to "fundamentals", "mce", "mcsa", "mcsd", "mcse", "mos", "mta", "role-based", "specialty".
exams tablica ciągów Lista skojarzonych egzaminów wymaganych do tego certyfikatu. Szczegółowe informacje o jednostkach można znaleźć w rekordach certyfikacji.
levels tablica ciągów Lista poziomów skojarzonych z tym certyfikatem, które wskazują, ile doświadczenia w roli jest konieczne, aby zrozumieć wszystkie aspekty egzaminów tego certyfikatu. Szczegółowe informacje o jednostkach można znaleźć w rekordach poziomu.
roles tablica ciągów Lista odpowiednich ról zadań dla tego certyfikatu. Szczegółowe informacje o rolach można odwoływać się do rekordów ról.
study_guide tablica obiektów Lista skojarzonej zawartości do badania dla tego certyfikatu. Szczegółowe informacje o obiektach można odwołać w skojarzonych rekordach.

Uwaga

Certyfikaty wymagające więcej niż jednego egzaminu będą obecne w tym rekordzie Certyfikaty odwołujące się do tablicy egzaminów.

Rekordy egzaminów

Każdy rekord egzaminu będzie miał następującą formę:

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

Szczegóły pola

Pole Typ opis
uid string Unikatowy identyfikator tego egzaminu — ta wartość będzie unikatowa we wszystkich środowiskach MS Learn.
title string Tytuł egzaminu w żądanych ustawieniach regionalnych lub angielski w USA jako rezerwowy.
subtitle string Podtytuł egzaminu w żądanych ustawieniach regionalnych lub us English jako rezerwowy.
display_name string Nazwa wyświetlana egzaminu w żądanych ustawieniach regionalnych lub angielski (USA) jako rezerwa.
url string W pełni kwalifikowany adres URL do egzaminu w środowisku Microsoft Learn w żądanych ustawieniach regionalnych.
icon_url string W pełni kwalifikowany adres URL do obrazu SVG 100x100, który reprezentuje egzamin.
pdf_download_url string W pełni kwalifikowany adres URL do pliku PDF przedstawiający umiejętności mierzone przez ten egzamin.
practice_test_url string W pełni kwalifikowany adres URL do testu praktycznego skojarzonego z egzaminem.
practice_assessment_url string W pełni kwalifikowany adres URL do bezpłatnej oceny praktyki skojarzonej z egzaminem.
locales tablica ciągów Lista języków, w których jest oferowany ten egzamin.
type string Typ rekordu. Wartość będzie zawsze mieć wartość "egzamin".
courses tablica ciągów Lista skojarzonych identyfikatorów UID kursu. Szczegółowe informacje o kursach można znaleźć w rekordach kursu.
levels tablica ciągów Lista poziomów skojarzonych z tym egzaminem, które wskazują, ile doświadczenia w roli jest konieczne, aby zrozumieć wszystkie aspekty tego egzaminu. Szczegółowe informacje o jednostkach można znaleźć w rekordach poziomu.
roles tablica ciągów Lista odpowiednich ról zadań dla tego egzaminu. Szczegółowe informacje o rolach można odwoływać się do rekordów ról.
products tablica ciągów Lista odpowiednich produktów, które obejmuje ten egzamin. Szczegółowe informacje o produktach można znaleźć w rekordach produktu.
providers tablica obiektów Lista dostawców tego egzaminu. Typ zawiera opis dostawcy i w pełni kwalifikowanego adresu URL z linkiem umożliwiającym zaplanowanie egzaminu u dostawcy.
study_guide tablica obiektów Lista skojarzonej zawartości do zbadania tego egzaminu. Szczegółowe informacje o obiektach można odwołać w skojarzonych rekordach.

Dokumentacja kursu prowadzonego przez instruktora

Każdy rekord kursu będzie miał następującą formę:

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

Szczegóły pola

Pole Typ opis
uid string Unikatowy identyfikator tego kursu prowadzonego przez instruktora — ta wartość będzie unikatowa we wszystkich środowiskach MS Learn.
course_number string Identyfikator numeru kursu prowadzonego przez instruktora.
title string Tytuł kursu prowadzonego przez instruktora w ustawieniach regionalnych, lub angielski w USA jako rezerwowy.
summary string Ciąg, który zawiera krótki opis prowadzonego przez instruktora. Wartość jest wyrażona jako tag akapitu HTML, w którym tekst wewnętrzny jest podsumowaniem.
duration_in_hours integer Średni czas ukończenia kursu prowadzonego przez instruktora w godzinach.
url string W pełni kwalifikowany adres URL do strony szczegółów kursu prowadzonego przez instruktora w usłudze Microsoft Learn w żądanych ustawieniach regionalnych.
icon_url string W pełni kwalifikowany adres URL do obrazu SVG o rozmiarze 100x100, który reprezentuje osiągnięcie kursu prowadzonego przez instruktora.
locales tablica ciągów Lista języków, w których ten kurs prowadzony przez instruktora jest oficjalnie oferowany. Inne języki mogą być obsługiwane przez partnerów szkoleniowych.
type string Typ rekordu. Wartość będzie zawsze "kursem" dla kursów prowadzonych przez instruktorów.
certification string Certyfikacja związana z kursem prowadzonym przez instruktora.
exam string Egzamin związany z kursem prowadzonym przez instruktora.
levels tablica ciągów Lista poziomów związanych z tym kursem prowadzonym przez instruktora, który wskazuje, ile doświadczenia w roli jest konieczne, aby zrozumieć wszystkie aspekty tego kursu. Szczegółowe informacje o jednostkach można znaleźć w rekordach poziomu.
study_guide tablica obiektów W pełni kwalifikowany adres URL do pliku PDF przedstawiający umiejętności mierzone przez ten certyfikat.

Rekordy poziomu, produktu, roli i podmiotu

Kolekcje levels, products, rolesi subjects zapewniają przyjazne nazwy wartości używanych w module i danych ścieżki szkoleniowej. Wszystkie cztery kolekcje mają ten sam kształt:

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

Będzie ona zgodna id z wartościami poziomów, produktów, ról i tematów uwzględnionych w innych wpisach wykazu. Skojarzona wartość name zapewnia poprawną nazwę wpisu w języku angielskim. Tablica children jest opcjonalna i umożliwia relacje hierarchiczne dla wartości mających relacje z elementami podrzędnymi, na przykład produktów.

Oto przykładowy zestaw możliwych ról:

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

Oto przykładowy zestaw produktów z elementami podrzędnymi dołączonymi w celu zapewnienia bardziej konkretnej kategorii produktów.

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

Przykłady kodu

Istnieje wiele sposobów wywoływania interfejsu API wykazu platformy Learn, ale poniższe przykłady kodu to przykłady sposobu jego użycia.

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 i 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);
}

Język PHP korzystający z rozszerzenia 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;

?>

Język PYTHON 3 korzystający z biblioteki "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)

Następne kroki

Zapoznaj się z poniższymi zasobami, aby ułatwić ci proces programowania: