مشاركة عبر

استرداد قائمة القواعد

  • مقالة

يتم تجميع القواعد معًا باستخدام مجموعة القواعد. بإمكان القاعدة أن تكون ضمن مجموعات قواعد متعددة أو ألا تكون ضمن أي مجموعة قواعد. استخدم طلب GET للحصول على قائمة بكافة القواعد المتوفرة أو القواعد في مجموعة قواعد أو مجموعات قواعد باستدعاء واجهة برمجة التطبيقات [Geographical URI]/api/rule. هناك بعض الاختلافات لاستدعاء واجهة برمجة التطبيقات هذه، ومع ذلك، فإن الاستخدام الأكثر شيوعًا هو استرداد قائمة القواعد لمجموعة قواعد محددة.

‏‫ملاحظة

تتطلب واجهة برمجة التطبيقات هذه رمزا مميزا OAuth .

الرؤوس

الاسم نوع القيمة المتوقعة مطلوب؟
Accept-Language string كود اللغة (على سبيل المثال، en-US). اللغة الافتراضية هي en-US. ‏‏لا.

المعلمات

الاسم نوع القيمة المتوقعة مطلوب؟
ruleset string اسم أو معرف مجموعة القواعد أو قائمة معرفات مجموعات القواعد أو أسماء مفصولة بفاصلة أو فاصلة منقوطة (على سبيل المثال، "مدقق الحلول"). ‏‏لا.
includeMessageFormats منطقي عند التعيين إلى true، يتم تضمين قائمة تباينات الرسائل المحتملة في نتائج طلبات اللغات، إذا كانت متوفرة. هذه القائمة مفيدة للترجمات إلى لغات متعددة. إذا لم يكن هناك حاجة إلى هذه المعلمة، فيمكنك عدم توفيرها أو توفير false لأن قيمة هذه المعلمة تزيد حجم الاستجابة ويمكن أن تزيد من وقت المعالجة. ‏‏لا.

الاستجابات المتوقعة

رمز حالة HTTP السيناريو نتيجة
200 تم العثور على نتيجة أو أكثر راجع المثال التالي في هذا المقال. قد يتم إرجاع نتيجة أو أكثر.
204 لم يتم العثور على نتائج لا توجد نتائج في النص الأساسي للاستجابة.
401 فشلت المصادقة لا توجد نتائج في النص الأساسي للاستجابة.

نص الاستجابة المتوقعة

يوضح الجدول التالي بنية الاستجابة لكل طلب (استجابة HTTP 200 فقط).

الخاصية كتابة القيمة المتوقعة مطلوب؟
الكود string معرف القاعدة، يشار إليه في بعض الأحيان كمعرف القاعدة. نعم
ملخص string ملخص القاعدة. نعم
الوصف string وصف أكثر تفصيلاً للقاعدة. نعم
guidanceUrl URI عنوان URL الذي سيتم فيه العثور على إرشادات منشورة. قد تكون هناك بعض الحالات التي لا توجد فيها مقالة إرشادات داعمة مخصصة. نعم
تضمين boolean الإشارة إلى الخدمة إلى أنه سيتم تضمين القاعدة في التحليل. هذه القيمة هي true لواجهة API. لا.
messageTemplates صفيف يتم تضمين قيمة الخاصية هذه فقط عندما يكون includeMessageFormats بقيمة true. لا.
messageTemplates.ruleId string إرجاع نفس قيمة المعرف للخاصية code. نعم
messageTemplates.messageTemplateId string هو معرف يتم استخدامه في تقرير Static Analysis Results Interchange Format (SARIF) للإشارة إلى وجود اختلاف في رسالة المشكلة بالنسبة للقاعدة. نعم
messageTemplates.messageTemplate string نص تباين الرسالة لسيناريو المشكلة الذي تبلغ عنه القاعدة. هذا النص عبارة عن سلسلة تنسيق قد تحتوي على رموز مميزة حيث يمكن استخدام الوسيطات المتوفرة في تقرير SARIF لإنشاء رسالة مفصلة. نعم

مثال: استرداد قواعد لمجموعة قواعد بلغة أخرى

يرجع هذا المثال بيانات لكل القواعد في مجموعة قواعد مدقق الحلول باللغة الفرنسية. إذا كانت اللغة المطلوبة هي الإنجليزية، فيمكنك إزالة الرأس Accept-Language.

طلب

GET [Geographical URI]/api/rule?ruleset=083A2EF5-7E0E-4754-9D88-9455142DC08B&api-version=2.0
x-ms-correlation-id: aaaa0000-bb11-2222-33cc-444444dddddd
Accept: application/json
Content-Type: application/json; charset=utf-8
Accept-Language: fr

رد

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
    {
        "description": "Ne pas implémenter d’activités de workflow Microsoft Dynamics CRM 4.0",
        "guidanceUrl": "https://go.microsoft.com/fwlink/?LinkID=398563&error=il-avoid-crm4-wf&client=PAChecker",
        "include": true,
        "code": "il-avoid-crm4-wf",
        "summary": "Ne pas implémenter d’activités de workflow Microsoft Dynamics CRM 4.0",
        "howToFix": {
            "summary": ""
        }
    },
    {
        "description": "Utiliser InvalidPluginExecutionException dans des plug-ins et activités de workflow",
        "guidanceUrl": "https://go.microsoft.com/fwlink/?LinkID=398563&error=il-use-standard-exception&client=PAChecker",
        "include": true,
        "code": "il-use-standard-exception",
        "summary": "Utiliser InvalidPluginExecutionException dans des plug-ins et activités de workflow",
        "howToFix": {
            "summary": ""
        }
    },
...
]

مثال: استرداد الكل

يرجع هذا المثال بيانات لكافة القواعد المتوفرة.

طلب

GET [Geographical URI]/api/rule?api-version=2.0
Accept: application/json
Content-Type: application/json; charset=utf-8

رد

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
    {
        "description": "Retrieve specific columns for an entity via query APIs",
        "guidanceUrl": "https://go.microsoft.com/fwlink/?LinkID=398563&error=il-specify-column&client=PAChecker",
        "include": true,
        "code": "il-specify-column",
        "summary": "Retrieve specific columns for an entity via query APIs",
        "howToFix": {
            "summary": ""
        }
    },
    {
        "description": "Do not duplicate plug-in step registration",
        "guidanceUrl": "https://go.microsoft.com/fwlink/?LinkID=398563&error=meta-remove-dup-reg&client=PAChecker",
        "include": true,
        "code": "meta-remove-dup-reg",
        "summary": "Do not duplicate plug-in step registration",
        "howToFix": {
            "summary": ""
        }
    },
...
]

مثال: استرداد مجموعة قواعد مع تنسيقات الرسائل

يرجع هذا المثال بيانات لكل القواعد في مجموعة قواعد مدقق الحلول باللغة الفرنسية. إذا كانت اللغة المطلوبة هي الإنجليزية، فيمكنك إزالة الرأس Accept-Language.

طلب

GET [Geographical URI]/api/rule?ruleset=083A2EF5-7E0E-4754-9D88-9455142DC08B&includeMessageFormats=true&api-version=2.0
Accept: application/json
Content-Type: application/json; charset=utf-8

رد

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
    {
        "description": "Do not implement Microsoft Dynamics CRM 4.0 workflow activities",
        "guidanceUrl": "https://go.microsoft.com/fwlink/?LinkID=398563&error=il-avoid-crm4-wf&client=PAChecker",
        "include": true,
        "code": "il-avoid-crm4-wf",
        "summary": "Do not implement Microsoft Dynamics CRM 4.0 workflow activities",
        "howToFix": {
            "summary": ""
        },
        "messageTemplates": [
            {
                "ruleId": "il-avoid-crm4-wf",
                "messageTemplateId": "message1",
                "messageTemplate": "Update the {0} class to derive from System.Workflow.Activities.CodeActivity, refactor Execute method implementation, and remove Microsoft.Crm.Workflow.CrmWorkflowActivityAttribute from type"
            },
            {
                "ruleId": "il-avoid-crm4-wf",
                "messageTemplateId": "message2",
                "messageTemplate": "Change the {0} property's type from {1} to {2} Argument <T> type"
            },
            {
                "ruleId": "il-avoid-crm4-wf",
                "messageTemplateId": "message3",
                "messageTemplate": "Replace the Microsoft.Crm.Workflow.Crm{0}Attribute with Microsoft.Xrm.Sdk.Workflow.{0}Attribute"
            },
            {
                "ruleId": "il-avoid-crm4-wf",
                "messageTemplateId": "message4",
                "messageTemplate": "Remove the {0} System.Workflow.ComponentModel.DependencyProperty type field"
            }
        ]
    },
    {
        "description": "Use InvalidPluginExecutionException in plug-ins and workflow activities",
        "guidanceUrl": "https://go.microsoft.com/fwlink/?LinkID=398563&error=il-use-standard-exception&client=PAChecker",
        "include": true,
        "code": "il-use-standard-exception",
        "summary": "Use InvalidPluginExecutionException in plug-ins and workflow activities",
        "howToFix": {
            "summary": ""
        },
        "messageTemplates": [
            {
                "ruleId": "il-use-standard-exception",
                "messageTemplateId": "message1",
                "messageTemplate": "An unguarded throw of type {0} was detected. Refactor this code to either throw an exception of type InvalidPluginExecutionException or guard against thrown exceptions of other types."
            },
            {
                "ruleId": "il-use-standard-exception",
                "messageTemplateId": "message2",
                "messageTemplate": "An unguarded rethrow of type {0} was detected. Refactor this code to either throw an exception of type InvalidPluginExecutionException or guard against thrown exceptions of other types."
            }
        ]
    },
...
]

راجع أيضًا

استخدام واجهة برمجة تطبيقات الويب المدقق Power Apps
استرداد قائمة مجموعات القواعد
تحميل ملف
استدعاء التحليل
تحقق من حالة التحليل