Načítanie zoznamu pravidiel

Pravidlá sú zoskupené podľa súboru pravidiel. Pravidlo môže byť v žiadnom súbore pravidiel alebo vo viacerých. Použite žiadosť GET na získanie zoznamu všetkých dostupných pravidiel, pravidiel v súbore pravidiel alebo súborov pravidiel volaním API [Geographical URI]/api/rule. Volanie tohto rozhrania API má niekoľko variácií, najbežnejším spôsobom je však získanie zoznamu pravidiel pre konkrétny súbor pravidiel.

Poznámka

Toto API vyžaduje token. OAuth

Hlavičky

Name Type Očakávaná hodnota Povinné?
Accept-Language reťazec Kód jazyka (napríklad en-US). Predvolená hodnota je en-US. no

Parametre

Name Type Očakávaná hodnota Povinné?
ruleset reťazec Názov alebo ID sady pravidiel alebo zoznam ID sady pravidiel, prípadne názvy oddelené čiarkou alebo bodkočiarkou (napríklad „Kontrola riešení“). no
includeMessageFormats bool Ak je nastavená na true, zoznam možných variácií správ je zahrnutý vo výsledkoch žiadostí o jazyky, ak sú k dispozícii. Tento zoznam je užitočný pri prekladoch do viacerých jazykov. Ak to nie je potrebné, tento parameter neposkytujte alebo uveďte false ako hodnotu, pretože tento parameter zväčšuje veľkosť odpovede a môže predĺžiť čas spracovania. no

Očakávané odpovede

Kód stavu HTTP Scenár Result
200 Bol nájdený jeden alebo viac výsledkov Pozrite si príklad ďalej v tomto článku. Môže sa vrátiť jeden alebo viac výsledkov.
204 Nenašli sa žiadne výsledky Žiadne výsledky v tele odpovede.
401 Overenie zlyhalo Žiadne výsledky v tele odpovede.

Očakávané telo odpovede

V nasledujúcej tabuľke je uvedená štruktúra odpovede pre každú požiadavku (iba odpoveď HTTP 200).

Vlastnosť Type Očakávaná hodnota Povinné?
kód reťazec Identifikátor pravidla, niekedy označovaný ako ID pravidla. Áno
súhrn reťazec Zhrnutie pravidla. Áno
description reťazec Podrobnejší popis pravidla. Áno
guidanceUrl URI URL, v ktorej nájdete publikované usmernenie. V niektorých prípadoch môže chýbať samostatný podporný článok s pokynmi. Áno
zahrnúť boolean Signalizuje službe, že pravidlo sa má zahrnúť do analýzy. Táto hodnota je pre toto API. true No
messageTemplates pole Táto hodnota vlastnosti je zahrnutá iba vtedy, keď includeMessageFormats je true. No
messageTemplates.ruleId reťazec Vracia rovnakú hodnotu ID ako vlastnosť code. Áno
messageTemplates.messageTemplateId reťazec Identifikátor používaný v zostave Static Analysis Results Interchange Format (SARIF) na signalizáciu variácie správy o probléme pre dané pravidlo. Áno
messageTemplates.messageTemplate reťazec Text variácie správy pre problémový scenár, ktorý vykazuje pravidlo. Tento text je formátovací reťazec, ktorý môže obsahovať tokeny, v ktorých možno argumenty uvedené v správe SARIF použiť na vytvorenie podrobnej správy. Áno

Príklad: načítať pravidlá pre súbor pravidiel v inom jazyku

Tento príklad vracia údaje pre všetky pravidlá v súbore pravidiel Kontrola riešenia vo francúzskom jazyku. Ak je požadovaný jazyk angličtina, odstráňte iba hlavičku Accept-Language.

Žiadosť

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

Odpoveď

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

Príklad: načítať všetky

Tento príklad vracia údaje pre všetky dostupné pravidlá.

Žiadosť

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

Odpoveď

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

Príklad: načítať súbor pravidiel s formátmi správ

Tento príklad vracia údaje pre všetky pravidlá v súbore pravidiel Kontrola riešenia vo francúzskom jazyku. Ak je požadovaný jazyk angličtina, odstráňte iba hlavičku Accept-Language.

Žiadosť

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

Odpoveď

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

Pozrite si tiež

Použite webové API rozhranie Checker Power Apps
Získať zoznam sád pravidiel
Nahrať súbor
Analýza vyvolania
Skontrolujte stav analýzy

  • Last updated on