Ережелер тізімін шығарып алу

Мақала
05/01/2024

Ережелер ережелер жиынтығымен бірге топтастырылған. Ереже ешбір ережелер жинағында немесе бірнеше ережелер жинағында бола алмайды. GET сұрауын API [Geographical URI]/api/rule шақыру арқылы қолжетімді барлық ережелер тізімін, ережелер жинағындағы ережелерді немесе ережелер жинағын алу үшін пайдаланыңыз. Бұл API-ді шақырудың бірнеше нұсқалары бар, дегенмен, белгілі бір ережелер жиынтығы үшін ережелер тізімін алу жиі кездеседі.

Ескертпе

Бұл API OAuth токенді қажет етеді.

Үстіңгі деректемелер

Аты	Түр	Күтілген мән	Міндетті ме?
Қабылдау-тіл	string	Тіл коды (мысалы, en-US). Әдепкі бойынша - en-US.	жоқ

Параметрлер

Аты	Түр	Күтілген мән	Міндетті ме?
ережелер жиынтығы	string	Ережелер жинағының аты немесе идентификаторы немесе ережелер жинағының идентификаторларының тізімі немесе үтір немесе нүктелі үтірмен бөлінген атаулар (мысалы, "Шешімді тексеруші").	жоқ
хабарлама пішімдерін қамтиды	логикалық	`true` күйіне орнатылғанда, ықтимал хабарлама түрленулерінің тізімі егер қолжетімді болса тіл(дер) сұрауларының нәтижелеріне қосылады. Бұл тізім бірнеше тілге аудармалар үшін пайдалы. Қажет болмаса, бұл параметрді бермеңіз немесе мән ретінде `false` бермеңіз, себебі бұл параметр жауап өлшемін арттырады және өңдеу уақытын ұзартады.	жоқ

Күтілген жауаптар

HTTP күй коды	Сценарий	Нәтиже
200	Бір немесе бірнеше нәтижелер табылды	Осы мақаладағы мысалды кейінірек қараңыз. Бір немесе бірнеше нәтиже қайтарылуы мүмкін.
204	Нәтижелер табылмады	Жауап беру мәтінінде нәтиже жоқ.
401-көше	Түпнұсқалық растама сәтсіз аяқталды	Жауап беру мәтінінде нәтиже жоқ.

Күтілген жауап мәтіні

Төмендегі кестеде әр сұранысқа жауап құрылымы көрсетілген (тек HTTP 200 жауаптары).

Сипат	Түрі	Күтілген мән	Міндетті ме?
код	string	Ереженің идентификаторы, кейде «ереже идентификаторы» деп те аталады.	Иә
Жиынтық	string	Ереженің қысқаша мазмұны.	Иә
сипаттама	string	Ереженің толығырақ сипаттамасы.	Иә
guidanceUrl	URI	Жарияланған нұсқаулықты табатын URL мекенжайы. Арнайы көмекші нұсқаулық мақаласы жоқ кейбір жағдайлар болуы мүмкін.	Иә
қосу	boolean	Ереженің талдауға қосылатындығы туралы қызмет сигналдары. Бұл мән `true` осы API үшін.	No
хабар үлгілері	массив	Бұл сипат мәні тек `includeMessageFormats` параметрі `true` күйіне орнатылғанда ғана қосылады.	Жоқ
messageTemplates.ruleId	string	Сол идентификатор мәнін `code` сипаты ретінде қайтарады.	Иә
messageTemplates.messageTemplateId	string	Статикалық талдау нәтижелерін алмастыру пішімі (SARIF) туралы есепте ереже үшін шығарылатын хабарламаның өзгеруін сигнал беру үшін пайдаланылатын идентификатор.	Иә
messageTemplates.messageTemplate	string	Ереже есеп беретін шығарылым сценарийіне арналған хабарлама мәтінінің нұсқасы. Бұл мәтін SARIF есебінде берілген дәлелдер егжей-тегжейлі хабарламаны құру үшін пайдаланылуы мүмкін таңбалауыштарды қамтуы мүмкін пішім жолы болып табылады.	Иә

Мысал: ережелер жинағына арналған ережелерді басқа тілде шығарып алу

Бұл мысал Шешімді тексеру ережелер жинағында француз тілінде барлық ережелер үшін деректерді қайтарады. Егер қалаған тіліңіз ағылшын тілі болса, онда қабылдау тілінің үстіңгі деректемесін алып тастаңыз.

Сұраныс

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

Мысал: хабарлама пішімдері бар ережелер жиынтығын шығарып алу

Сұраныс

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 &lt;T&gt; 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 пайдаланыңыз
Ережелер жинағының тізімін шығарып алыңыз
Файлды жүктеп салыңыз
Талдауды шақыру
Талдау күйін тексеріңіз

Бөлісу құралы:

Ережелер тізімін шығарып алу

Үстіңгі деректемелер

Параметрлер

Күтілген жауаптар

Күтілген жауап мәтіні

Мысал: ережелер жинағына арналған ережелерді басқа тілде шығарып алу

Мысал: барлығын шығарып алу

Мысал: хабарлама пішімдері бар ережелер жиынтығын шығарып алу

Сондай-ақ, келесіні қараңыз

Кері байланыс

Қосымша ресурстар