नियमों की सूची पुनः प्राप्त करें

नियम-सेट का उपयोग करके नियमों को एक साथ समूहीकृत किया जाता है. नियम बिना किसी नियमसेट या एकाधिक नियमसेट में हो सकता है. API [Geographical URI]/api/rule कॉल करके सभी उपलब्ध नियमों की सूची, नियमसेट में नियम, या नियमसेट प्राप्त करने के लिए GET अनुरोध का उपयोग करें. इस API को कॉल करने के लिए कुछ विविधताएं हैं, हालांकि, सबसे आम उपयोग है किसी एक विशिष्ट नियमसेट के लिए नियमों की सूची को पुनः प्राप्त करना.

नोट

इस API को OAuth टोकन की आवश्यकता होती है।

शीर्ष लेख

नाम	Type	अपेक्षित मान	आवश्यक?
भाषा-स्वीकार करें	string	भाषा कोड (उदाहरण के लिए, en-US). डिफ़ॉल्ट en-US है.	नहीं

पैरामीटर्स

नाम	प्रकार	अपेक्षित मान	आवश्यक?
नियमसेट	string	नियम सेट का नाम या ID या नियम सेट ID की सूची, या अल्पविराम या अर्धविराम से अलग किए गए नाम (उदाहरण के लिए, "समाधान परीक्षक").	नहीं
includeMessageFormats	बूल	true पर सेट करने पर, अगर उपलब्ध हो तो, भाषाओं के अनुरोधों के परिणामों में संभावित संदेश विविधताओं की सूची शामिल होती है. यह सूची अनेक भाषाओं में अनुवाद के लिए उपयोगी है। यदि आवश्यक न हो, तो यह पैरामीटर न दें या false को मान के रूप में प्रदान करें क्योंकि यह पैरामीटर प्रत्युत्तर के आकार को बढ़ाता है और प्रसंस्करण समय बढ़ा सकता है।	नहीं

अपेक्षित प्रतिक्रियाएँ

HTTP स्थिति कोड	परिदृश्य	परिणाम
200	एक या अधिक परिणाम पाए गए	इस लेख में आगे उदाहरण देखें. एक या अधिक परिणाम लौटाए जा सकते हैं.
204	कोई परिणाम नहीं मिला	प्रतिक्रिया भाग में कोई परिणाम नहीं.
401	प्रमाणीकरण विफल रहा	प्रतिक्रिया भाग में कोई परिणाम नहीं.

अपेक्षित प्रतिक्रिया भाग

निम्न तालिका प्रत्येक अनुरोध (केवल HTTP 200 प्रतिक्रिया) के लिए प्रतिक्रिया की संरचना को रेखांकित करती है.

गुण	प्रकार	अपेक्षित मान	आवश्यक?
कोड	string	नियम का पहचानकर्ता, जिसे कभी-कभी नियम ID के रूप में संदर्भित किया जाता है.	हां
सारांश	string	नियम का सारांश.	हां
विवरण	string	नियम का अधिक विस्तृत वर्णन.	हां
guidanceUrl	URI	वह URL जिसमें प्रकाशित मार्गदर्शन ढूंढना है. कुछ मामले ऐसे भी हो सकते हैं जहां कोई समर्पित सहायक मार्गदर्शन लेख उपलब्ध न हो।	हां
इसमें शामिल हैं	boolean	सेवा को संकेत देता है कि नियम को विश्लेषण में शामिल किया जाना है. यह मान इस API के लिए है. true	No
messageTemplates	सरणी	यह गुण मान केवल तभी शामिल किया जाता है जब includeMessageFormats true होता है.	नहीं
messageTemplates.ruleId	string	code गुण के समान ID मान लौटाता है.	हां
messageTemplates.messageTemplateId	string	नियम के लिए समस्या संदेश भिन्नता का संकेत देने के लिए स्थैतिक विश्लेषण परिणाम इंटरचेंज फ़ॉर्मेट (SARIF) रिपोर्ट में उपयोग होने वाला एक पहचानकर्ता.	हां
messageTemplates.messageTemplate	string	नियम द्वारा रिपोर्ट किए गए समस्या परिदृश्य के लिए संदेश भिन्नता का पाठ. यह पाठ एक प्रारूप स्ट्रिंग है जिसमें टोकन हो सकते हैं, जिसमें SARIF रिपोर्ट में दिए गए तर्कों का उपयोग विस्तृत संदेश बनाने के लिए किया जा सकता है।	हां

उदाहरण: नियमसेट के लिए किसी अन्य भाषा में नियम पुनः प्राप्त करना

यह उदाहरण Solution Checker नियमसेट में सभी नियमों के लिए डेटा को फ्रेंच भाषा में लौटाता है. यदि इच्छित भाषा अंग्रेजी है, तो बस भाषा-स्वीकार करें हेडर हटा दें.

अनुरोध

GET [Geographical URI]/api/rule?ruleset=083A2EF5-7E0E-4754-9D88-9455142DC08B&api-version=2.0
x-ms-correlation-id: 9E378E56-6F35-41E9-BF8B-C0CC88E2B832
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": ""
        }
    },
...
]

उदाहरण: संदेश फ़ॉर्मेट के साथ एक नियमसेट के लिए पुनः प्राप्त करना

यह उदाहरण Solution Checker नियमसेट में सभी नियमों के लिए डेटा को फ्रेंच भाषा में लौटाता है. यदि इच्छित भाषा अंग्रेजी है, तो बस भाषा-स्वीकार करें हेडर हटा दें.

अनुरोध

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 चेकर वेब API का उपयोग करें
नियम-सेट की सूची प्राप्त करें
एक फ़ाइल अपलोड करें
विश्लेषण का आह्वान करें
विश्लेषण स्थिति की जाँच करें