שתף באמצעות


תיעוד למפתחי API של Microsoft Learn Catalog

מאמר זה מספק מידע עבור מפתחים ומבקשות המיישמים את ה- API Microsoft Learn Catalog. מומלץ גם לתעד את שיטות העבודה המומלצות עבור API עבור, ו- הנפוצות כדי לתמוך במסע הפיתוח שלך.

נקודת קצה של API

ממשק ה- API של Microsoft Learn הוא API אינטרנט מבוסס-REST שמחזיר תגובה המקודדת על-ידי JSON. כדי לבקש את הקטלוג המלא, שלח בקשת GET אל:

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

הערה

נקודת הקצה המפורטת לעיל היא נקודת הקצה הנוכחית. אם אתה משתמש בנקודות קצה ישנות יותר, היא תמשיך לפעול כצפוי בעת הצירוף, אך היתרונות במעבר אל נקודת הקצה החדשה הם שהיא תספק לך תכונות משופרות כגון פרמטרים נוספים של שאילתה.

פרמטרי שאילתה

להלן פרמטרי השאילתה שהבקשה יכולה לכלול. כולם אופציונליים. עליך לקודד את ערכי הפרמטר של השאילתה באמצעות כתובת URL. באפשרותך להשתמש בנקודות הקצה עם פרמטרים אלה, אחד, חלק מהם או כולם.

חשוב

אם אתה משתמש ביותר מהשאילתה אחת, השאילתה תיערך באמצעות האופרטור AND.

שם ערך סוג חובה דוגמה
אזור קוד אזור חוקי יחיד מרשימת הנתמכת של אזורים. המטה-נתונים המוחזרים יהיו באזור המבוקש, אם הם זמינים. אם פרמטר זה אינו מסופק, en-us התגובה המוחזרת. מחרוזת לא ?locale=en-us
סוג רשימה מופרדת באמצעות פסיקים של אחד או יותר מהתוכן ברמה העליונה או של אובייקטי הטקסונומיה שאנו מספקים כעת בתגובה להחזרה. הערכים הנתמכים הם: modules, units, learningPaths, appliedSkills, certifications, mergedCertifications, exams, courses, levels, roles, products, subjects. מחרוזת לא ?type=modules,learningPaths
מזהה ייחודי (uid) רשימה מופרדת באמצעות פסיקים של מזהה תוכן ייחודי חוקי (uid) חוקי אחד או יותר מסוגי התוכן הזמינים. הערה: uids הם תלויי רישיות. מחרוזת לא ?uid=learn.azure.intro-to-azure-fundamentals
last_modified אופרטור ותאריך ושעה לסינון לפי תאריך השינוי האחרון של אובייקטים. האופרטור כולל lt (קטן מ), lte (קטן או שווה ל), eq (שווה ל), gt (גדול מ), gte (גדול או שווה ל). בעת שימוש בפרמטר זה, האופרטור יתווסף כברירת gte אם לא צוין. מחרוזת לא ?last_modified=gte 2022-01-01
הפופולריות אופרטור וערך לסינון לפי ערך הפופולריות (בטווח של 0-1) של אובייקטים. האופרטור כולל lt (קטן מ), lte (קטן או שווה ל), eq (שווה ל), gt (גדול מ), gte (גדול או שווה ל). בעת שימוש בפרמטר זה, האופרטור יתווסף כברירת gte אם לא צוין. מחרוזת לא ?popularity=gte 0.5
רמה רשימה מופרדת באמצעות פסיק של אחת או יותר מרמות הזמינות כעת (הרשימה המלאה נמצאת רמות האובייקט של תגובת ה- API). מחרוזת לא ?level=beginner
תפקיד רשימה מופרדת באמצעות פסיק של אחד או יותר מהתפקידים הזמינים כעת (הרשימה המלאה נמצאת תפקידי של תגובת ה- API). מחרוזת לא ?role=developer
מכפלה רשימה מופרדת באמצעות פסיק של אחד או יותר מהתפקידים הזמינים כעת (הרשימה המלאה נמצאת המופרדים האובייקט של תגובת ה- API). ה- API אינו תומך בהירארכיית מוצרים, לכן הוסף כל מוצר לרשימה שברצונך לכלול בשאילתה. מחרוזת לא ?product=azure
נושא רשימה מופרדת באמצעות פסיק של אחד או יותר מהתפקידים הזמינים כעת (הרשימה המלאה מופיעה נושאים של תגובת ה- API). ה- API אינו תומך בהירארכיית נושאים, לכן הוסף כל נושא לרשימה שברצונך לכלול בשאילתה. מחרוזת לא ?subject=cloud-computing

שאילתות לדוגמה

השאילתות המפורטות להלן הן דוגמאות שיעזרו לך לקבל תחושה של מה באפשרותך לבקש וכיצד ליצור את הבקשה.

תיאור שאילתה
כל הפריטים ב- API של קטלוג Learn https://learn.microsoft.com/api/catalog/
כל המודולים הספרדית https://learn.microsoft.com/api/catalog/?locale=es-es&type=modules
כל המודולים עם ניקוד פופולריות של 0.9 ומעלה https://learn.microsoft.com/api/catalog/?type=modules&popularity>0.9
כל אובייקטי הדרכה ואישורים בנושא אבטחה למתחילים https://learn.microsoft.com/api/catalog/?level=beginner&subject=security
כל מודולי הנגישות המתקדמות עם ניקוד פופולריות מעל 0.5 ועודכנו בחודש האחרון https://learn.microsoft.com/api/catalog/?level=advanced&subject=accessibility&popularity>0.5&last_modified=gte 2022-10-01

תגובת API

השירות עשוי להחזיר את קודי המצב הבאים של HTTP.

קוד מצב תיאור
200 הצלחה. גוף התגובה כולל את הנתונים המקודדים באמצעות JSON.
400 אחד מהפרמטרים של השאילתה חסר או אינו חוקי.
404 כתובת ה- URL לא נמצאה בשרת.
500 שגיאת שרת לא צפויה.
503 השירות אינו זמין באופן זמני.

תגובה מוצלחת תכלול פרטים על כל המודולים ונתלי הלמידה, כפי שמוצג להלן.

גוף תגובה

גוף תגובה מוצלח מקודד ב- JSON ויש לו 12 מקטעים:

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

לכל מערך יש אובייקט מקודד אחד או יותר בקידוד JSON המכיל נתונים ספציפיים למקטע זה של התגובה.

  1. modules: הוא מערך של מודולים שפורסמו.
  2. units: הוא מערך של יחידות שפורסמו.
  3. learningPaths: הוא מערך של נתיבי למידה שפורסמו.
  4. appliedSkills: הוא מערך של מיומנויות שהוחלו שפורסמו.
  5. mergedCertifications: הוא מערך של אישורים שפורסמו, ממוזג עם מבחנים.
  6. certifications: הוא מערך של אישורים שפורסמו.
  7. exams: הוא מערך של מבחנים שפורסמו.
  8. courses: הוא מערך של קורסי הדרכה מונחים שפורסמו.
  9. levels: הוא מערך של רמות קהל אפשריות.
  10. products: הוא מערך של מוצרים ושירותים אפשריים המכוסים בקטלוג.
  11. roles: הוא מערך של תפקידי משימה אפשריים.
  12. subjects: הוא מערך של תגיות נושא אפשריות.

רשומות מודול

רשומות מודול

כל רשומת מודול תכלול את הטופס הבא:

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

פרטי שדה

שדה סוג תיאור
summary מחרוזת מחרוזת המספקת תיאור קצר של המודול. הערך מבוטא כתג פיסקה של HTML כאשר הטקסט הפנימי הוא סיכום.
levels מערך של מחרוזות רשימה של הרמות המשויכות למודול זה, שמציינות את החוויה בתפקיד הדרושה כדי להבין את כל ההיבטים של מודול זה. פרטים אודות היחידות זמינים להפניה לרשומות ברמה.
roles מערך של מחרוזות רשימה של תפקידי המשימה במודול זה רלוונטיים.
products מערך של מחרוזות רשימה של מוצרים רלוונטיים שמודול זה מכסה. פרטים אודות המוצרים זמינים להפניה לרשומות המוצר.
subjects מערך של מחרוזות רשימה של נושאים רלוונטיים שנתיב למידה זה מכסה.
uid מחרוזת מזהה ייחודי עבור מודול זה - ערך זה יהיה ייחודי בכל MS Learn.
type מחרוזת סוג הרשומה. הערך יהיה תמיד 'מודול'.
title מחרוזת הכותרת עבור המודול באזור המבוקש, או אנגלית ארה"ב כחזרה.
duration_in_minutes מספר שלם משך הזמן הממוצע שנדרש להשלמת מודול זה בדקות.
rating חפץ מכיל count, שהוא מספר האנשים לדירוג המודול, average, צבירה של הדירוגים, אשר יהיה 1-5
popularity כפול ערך מנושר מ- 0-1 המציין את הפופולריות של המודול
icon_url מחרוזת כתובת URL מלאה לתמונת SVG של 100x100 המייצגת את תמונת ההישג של המודול עם רקע שקוף.
social_image_url מחרוזת כתובת URL מלאה לתמונת PNG המייצגת את תמונת ההישג במודול עם רקע אטום מלבני, התואם לחוויות מדיה חברתית או אריחים. אם הוא אינו זמין עבור מודול זה, מאפיין זה לא יוחזר בתגובה.
locale מחרוזת השפה בה נכתבים נתוני JSON אלה. ערך זה יהיה האזור המבוקש אם זמין, או 'en-us' אם לא.
last_modified תמר בפעם האחרונה במודול זה היה תיקון משמעותי.
url מחרוזת כתובת URL מלאה למודול Learn באזור המבוקש.
firstUnitUrl מחרוזת כתובת URL מלאה ליחידה הראשונה של מודול Learn באזור המבוקש.
units מערך של מחרוזות רשימה של ממשקי המשתמש המשויכים ליחידה. פרטים אודות היחידות זמינים להפניה לרשומות היחידות.
number_of_children מספר שלם מספר העמודים (יחידות) שיש במודול זה.

רשומות יחידות

לכל רשומת יחידה יופיע הטופס הבא:

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

הערה

רשומת היחידה אינה כוללים את כתובת ה- URL המשויכת מאחר שיחיחידות אינן נכתבות כתוכן עצמאי. הם נועדו להילקח בסדר מסוים עבור המודול. מסיבה זו, נכלול את הקישור לדף פרטי המודול ואת היחידה הראשונה ברשומת המודול כדי שהמשתמשים יוכלו להתחיל שם ולהמשיך בתוכן. עם זאת, ניתן להשתמש ברשומות היחידות כדי לקבל פרטים אודות היחידות שיש להציג במערכת ניהול הלמידה (LMS) או בחוויות אחרות.

פרטי שדה

שדה סוג תיאור
uid מחרוזת מזהה ייחודי עבור מודול זה - ערך זה יהיה ייחודי בכל MS Learn.
type מחרוזת סוג הרשומה. הערך יהיה תמיד 'יחידה'.
title מחרוזת הכותרת עבור היחידה באזור המבוקש, או אנגלית ארה"ב כחזרה.
duration_in_minutes משך היחידה. אם תוסיף את duration_in_minutes היחידות המשויכות לכל מודול, תקבל את זמן המודול הכולל.
locale מחרוזת השפה בה נכתבים נתוני JSON אלה. ערך זה יהיה האזור המבוקש אם זמין, או 'en-us' אם לא.
last_modified תמר בפעם האחרונה במודול זה היה תיקון משמעותי.

רשומות נתיב למידה

כל רשומת נתיב למידה תכלול את הטופס הבא:

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

פרטי שדה

שדה סוג תיאור
summary מחרוזת מחרוזת המספקת תיאור קצר של נתיב הלמידה. הערך מבוטא כתג פיסקה של HTML כאשר הטקסט הפנימי הוא סיכום.
levels מערך של מחרוזות רשימה של הרמות המשויכות לנתיב למידה זה, אשר מציינת את החוויה בתפקיד הדרושה כדי להבין את כל ההיבטים של נתיב למידה זה. פרטים אודות היחידות זמינים להפניה לרשומות ברמה.
roles מערך של מחרוזות רשימה של תפקידי המשרה הרלוונטיים עבור נתיב למידה זה.
products מערך של מחרוזות רשימה של מוצרים רלוונטיים שנתיב למידה זה מכסה. פרטים אודות המוצרים זמינים להפניה לרשומות המוצר.
subjects מערך של מחרוזות רשימה של נושאים רלוונטיים שנתיב למידה זה מכסה.
uid מחרוזת מזהה ייחודי עבור נתיב למידה זה - ערך זה יהיה ייחודי בכל MS Learn.
type מחרוזת סוג הרשומה. הערך יהיה תמיד 'learningPath'.
title מחרוזת הכותרת של נתיב הלמידה באזור המבוקש, או אנגלית ארה"ב כחזרה.
duration_in_minutes מספר שלם משך הזמן הממוצע שנדרש להשלמת נתיב למידה זה בדקות. ערך זה הוא סכום נתונים מכל המודולים הכלולים.
rating חפץ מכיל count, שהוא מספר האנשים לדירוג נתיב הלמידה, average, צבירה של הדירוגים, אשר יהיה 1-5
popularity כפול ערך מנושר מ- 0-1 המציין את הפופולריות של נתיב הלמידה
icon_url מחרוזת כתובת URL מלאה לתמונת SVG של 100x100 המייצגת את נתיב הלמידה.
social_image_url מחרוזת כתובת URL מלאה לתמונת PNG המייצגת את תמונת ההישג של נתיב הלמידה עם רקע אטום מלבן, המותאם לחוויות מדיה חברתית או אריחים. אם הוא אינו זמין עבור מודול זה, מאפיין זה לא יוחזר בתגובה.
locale מחרוזת השפה בה נכתבים נתוני JSON אלה. ערך זה יהיה האזור המבוקש אם זמין, או 'en-us' אם לא.
last_modified תמר הפעם האחרונה שבה נתיב למידה זה השתנה.
url מחרוזת כתובת URL מלאה לנתיב הלמידה ב- Microsoft Learn באזור המבוקש.
firstModuleUrl מחרוזת כתובת URL מלאה למודול הראשון של נתיב הלמידה ב- Microsoft Learn באזור המבוקש.
modules מערך של מחרוזות רשימה של ממשקי המשתמש של המודול המשויכים. פרטים אודות המודולים זמינים להפניה לרשומות המודול.
number_of_children מספר שלם מספר המודולים שיש בנתיב למידה זה.

רשומות של מיומנויות שהוחלו

כל רשומת כישורים שהוחלו תכלול את הטופס הבא:

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

פרטי שדה

שדה סוג תיאור
uid מחרוזת מזהה ייחודי עבור מיומנות שהוחלה זו - ערך זה יהיה ייחודי בכל MS Learn.
locale מחרוזת השפה בה נכתבים נתוני JSON אלה. ערך זה יהיה האזור המבוקש אם זמין, או 'en-us' אם לא.
title מחרוזת הכותרת עבור המיומנות שהוחלה באזור המבוקש, או אנגלית ארה"ב כחזרה.
summary מחרוזת הסיכום עבור המיומנות שהוחלה באזור המבוקש, או אנגלית ארה"ב כחזרה.
url מחרוזת כתובת URL מלאה למיומנות שהוחלה ב- Microsoft Learn באזור המבוקש.
icon_url מחרוזת כתובת URL מלאה לתמונת SVG של 100x100 המייצגת את המיומנות שהוחלה (כאשר היא זמינה, אחרת לא נכללה).
levels מערך של מחרוזות רשימה של הרמות המשויכות למיומנות שהוחלה זו.
roles מערך של מחרוזות רשימה של תפקידי התפקיד הרלוונטיים עבור מיומנות שהוחלה זו. פרטים אודות התפקידים זמינים להפניה לרשומות התפקידים.
subjects מערך של מחרוזות רשימה של נושאים רלוונטיים שמיומנות שהוחלה מכסה.
study_guide מערך אובייקטים רשימה של התוכן המשויך ללמוד עבור מיומנות שהוחלה זו. ניתן להפנות אל פרטים אודות האובייקטים לרשומות המשויכות להם.
last_modified תמר הפעם האחרונה שמיומנות שהוחלה זו השתנתה.

רשומות אישורים ממוזגות

כל רשומת אישור ממוזגת תכלול את הטופס הבא:

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

פרטי שדה

שדה סוג תיאור
uid מחרוזת מזהה ייחודי עבור אישור זה - ערך זה יהיה ייחודי בכל MS Learn.
title מחרוזת הכותרת עבור האישור באזור המבוקש, או אנגלית ארה"ב כחזרה.
summary מחרוזת סיכום האישור באזור המבוקש, או אנגלית ארה"ב כחזרה.
url מחרוזת כתובת URL מלאה לאישור ב- Microsoft Learn באזור המבוקש.
icon_url מחרוזת כתובת URL מלאה לתמונת SVG של 100x100 המייצגת את האישור.
last_modified תמר הפעם האחרונה שבה אישור זה השתנה.
type מחרוזת סוג הרשומה. הערך יהיה תמיד 'אישור'.
certification_type מחרוזת סוג האישור. הערכים האפשריים הם 'fundamentals', 'mce', 'mcsa', 'mcsd', 'mcse', 'mos', 'mta', 'role-based', 'specialty'.
products מערך של מחרוזות רשימה של מוצרים רלוונטיים שהסמכה זו מכסה. פרטים אודות המוצרים זמינים להפניה לרשומות המוצר.
levels מערך של מחרוזות רשימה של הרמות המשויכות לאישור זה, שמציינות את החוויה בתפקיד הדרושה כדי להבין את כל ההיבטים של הבחינות של אישור זה. פרטים אודות היחידות זמינים להפניה לרשומות ברמה.
roles מערך של מחרוזות רשימה של תפקידי התפקיד הרלוונטיים עבור אישור זה. פרטים אודות התפקידים זמינים להפניה לרשומות התפקידים.
subjects מערך של מחרוזות רשימה של נושאים רלוונטיים שהסמכה זו מכסה.
renewal_frequency_in_days מספר שלם מספר הימים לפני שתוקף אישור זה יפוג ויש לחדש אותו. אם הערך הוא 0, תוקפו של האישור לא יפוג.
prerequisites מערך של מחרוזות רשימה של הדרישות המוקדמות המומלצות כדי לזכות באישורים אלה. ניתן להפנות פרטים אודות האישורים לרשומות האישורים.
skills מערך של מחרוזות רשימה של הכישורים הנמדדים על המבחן הנדרש לאישור זה.
recommendation_list מערך של מחרוזות רשימה של המומלץ הקשורים לאישור זה.
study_guide מערך אובייקטים רשימה של התוכן המשויך ללמידה עבור אישור זה. ניתן להפנות אל פרטים אודות האובייקטים לרשומות המשויכות להם.
exam_duration_in_minutes מספר שלם מספר הדקות שהוקצו להשלמת המבחן.
locales מערך של מחרוזות רשימת השפות בה מוצע אישור זה.
providers מערך אובייקטים רשימת ספקים עבור אישור זה. הסוג מתאר איזה ספק וכתובת URL מלאה עם קישור לתזמון מבחן עם הספק.
career_paths מערך אובייקטים רשימה של נתיבי קריירה עבור אישור זה.

הערה

אישורים הדורשים בדיקה אחת בלבד יוחזרו כחלק מהמאפיין הממוזגCertifications.

רשומות אישורים

כל רשומת אישור תכלול את הטופס הבא:

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

פרטי שדה

שדה סוג תיאור
uid מחרוזת מזהה ייחודי עבור אישור זה - ערך זה יהיה ייחודי בכל MS Learn.
title מחרוזת הכותרת עבור האישור באזור המבוקש, או אנגלית ארה"ב כחזרה.
subtitle מחרוזת כותרת המשנה לאישור באזור המבוקש, או אנגלית ארה"ב כחזרה.
url מחרוזת כתובת URL מלאה לאישור ב- Microsoft Learn באזור המבוקש.
icon_url מחרוזת כתובת URL מלאה לתמונת SVG של 100x100 המייצגת את האישור.
type מחרוזת סוג הרשומה. הערך יהיה תמיד 'אישור'.
certification_type מחרוזת סוג האישור. הערכים האפשריים הם 'fundamentals', 'mce', 'mcsa', 'mcsd', 'mcse', 'mos', 'mta', 'role-based', 'specialty'.
exams מערך של מחרוזות רשימה של הבחינות המשויכות הנדרשות לאישור זה. ניתן להפנות פרטים אודות היחידות לרשומות האישור.
levels מערך של מחרוזות רשימה של הרמות המשויכות לאישור זה, שמציינות את החוויה בתפקיד הדרושה כדי להבין את כל ההיבטים של הבחינות של אישור זה. פרטים אודות היחידות זמינים להפניה לרשומות ברמה.
roles מערך של מחרוזות רשימה של תפקידי התפקיד הרלוונטיים עבור אישור זה. פרטים אודות התפקידים זמינים להפניה לרשומות התפקידים.
study_guide מערך אובייקטים רשימה של התוכן המשויך ללמידה עבור אישור זה. ניתן להפנות אל פרטים אודות האובייקטים לרשומות המשויכות להם.

הערה

אישורים המחייבים יותר ממבחן אחד יופיעו ברשומת אישורים זו המתייחסים למערך הבחינות.

רשומות מבחנים

כל רשומת מבחן תכלול את הטופס הבא:

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

פרטי שדה

שדה סוג תיאור
uid מחרוזת מזהה ייחודי עבור מבחן זה - ערך זה יהיה ייחודי בכל MS Learn.
title מחרוזת הכותרת עבור המבחן באזור המבוקש, או אנגלית ארה"ב כחזרה.
subtitle מחרוזת כותרת המשנה למבחן באזור המבוקש, או אנגלית ארה"ב כחזרה.
display_name מחרוזת שם התצוגה עבור המבחן באזור המבוקש, או אנגלית ארה"ב כחזרה.
url מחרוזת כתובת URL מלאה למבחן ב- Microsoft Learn באזור המבוקש.
icon_url מחרוזת כתובת URL מלאה לתמונת SVG של 100x100 המייצגת את המבחן.
pdf_download_url מחרוזת כתובת URL מלאה ל- PDF המחלוקה לרמות של הכישורים הנמדדים על-ידי מבחן זה.
practice_test_url מחרוזת כתובת URL מלאה למבחן תרגול המשויך למבחן.
practice_assessment_url מחרוזת כתובת URL מלאה להערכת תרגול ללא תשלום המשויכת למבחן.
locales מערך של מחרוזות רשימת שפות שבחינה זו מציעה.
type מחרוזת סוג הרשומה. הערך יהיה תמיד 'מבחן'.
courses מערך של מחרוזות רשימה של ממשקי המשתמש המשויכים של הקורס. פרטים אודות הקורסים זמינים להפניה לרשומות הקורס.
levels מערך של מחרוזות רשימה של הרמות המשויכות למבחן זה, שמציינות את החוויה בתפקיד הדרושה כדי להבין את כל ההיבטים של מבחן זה. פרטים אודות היחידות זמינים להפניה לרשומות ברמה.
roles מערך של מחרוזות רשימה של תפקידי התפקיד הרלוונטיים עבור מבחן זה. פרטים אודות התפקידים זמינים להפניה לרשומות התפקידים.
products מערך של מחרוזות רשימה של מוצרים רלוונטיים שבחינה זו מכסה. פרטים אודות המוצרים זמינים להפניה לרשומות המוצר.
providers מערך אובייקטים רשימה של ספקים עבור מבחן זה. הסוג מתאר איזה ספק וכתובת URL מלאה עם קישור לתזמון מבחן עם הספק.
study_guide מערך אובייקטים רשימה של התוכן המשויך ללמידה עבור מבחן זה. ניתן להפנות אל פרטים אודות האובייקטים לרשומות המשויכות להם.

רשומות קורס בהנחיית מדריך

כל רשומת קורס תכלול את הטופס הבא:

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

פרטי שדה

שדה סוג תיאור
uid מחרוזת מזהה ייחודי עבור קורס זה בהנחיית מדריך - ערך זה יהיה ייחודי בכל MS Learn.
course_number מחרוזת מזהה מספר הקורס בהנחיית מדריך.
title מחרוזת הכותרת של הקורס בהנחיית מדריך באזור המבוקש, או אנגלית ארה"ב כחזרה.
summary מחרוזת מחרוזת המספקת תיאור קצר של מדריך ההנחות. הערך מבוטא כתג פיסקה של HTML כאשר הטקסט הפנימי הוא סיכום.
duration_in_hours מספר שלם הזמן הממוצע שנדרש להשלמת קורס זה בהנחיית מדריך בשעות.
url מחרוזת כתובת URL מלאה לדף הפרטים של הקורס בהנחיית מדריך ב- Microsoft Learn באזור המבוקש.
icon_url מחרוזת כתובת URL מלאה לתמונת SVG של 100x100 המייצגת את ההישג של הקורס בהנחיית מדריך.
locales מערך של מחרוזות רשימה של שפות בקורס בהנחיית מדריך זה מוצעת באופן רשמי. שותפי למידה עשויים להוסיף תמיכה בשפות אחרות.
type מחרוזת סוג הרשומה. הערך יהיה תמיד 'קורס' עבור קורסים בהנחיית מדריך.
certification מחרוזת הסמכה המשויכת לקורס בהנחיית מדריך.
exam מחרוזת מבחן המשויך לקורס בהנחיית מדריך.
levels מערך של מחרוזות רשימה של הרמות המשויכות לקורס בהנחיית מדריך זה, שמציינות כמה ניסיון בתפקיד דרוש כדי להבין את כל ההיבטים בקורס זה. פרטים אודות היחידות זמינים להפניה לרשומות ברמה.
study_guide מערך אובייקטים כתובת URL מלאה ל- PDF המחלוקה לרמות של הכישורים הנמדדים על-ידי אישור זה.

רשומות של רמות, מוצרים, תפקידים ונושאים

האוספים levels, products, roles, ו- subjects מספקים שמות ידידותיים עבור הערכים המשמשים במודול ותוני נתיב הלמידה. לכל ארבעת האוספים יש אותה צורה:

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

הטבלה id להתאים לערכים עבור רמות, מוצרים, תפקידים ונושאים הכלולים בררכי הקטלוג האחרים. התיקיה name מספקת שם מתאים באנגלית עבור הערך. מערך children הוא אופציונלי ומאפשר הירארכיות עבור ערכים בעלי קשרי גומלין בין צאצאים כגון מוצרים.

כדוגמה, להלן קבוצה של תפקידים אפשריים:

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

הנה קבוצה לדוגמה של מוצרים, עם ילדים הכלולים כדי לספק קטגוריית מוצר ספציפית יותר.

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

דוגמאות קוד

קיימות דרכים רבות לקרוא ל- API של קטלוג Learn, אך דוגמאות הקוד להלן הן דוגמאות לאופן שבו ניתן להשתמש בו.

jQuery (2016).

$(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 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 באמצעות הרחבת 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 באמצעות ספריית 'בקשות'


#!/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)

השלבים הבאים

עיין במשאבים הבאים שיעזרו לך במסע הפיתוח: