Share via

Pridobivanje seznama pravil

  • Članek

Pravila so združena z naborom pravil. Pravilo je lahko v več naborih pravil ali v nobenem naboru. Uporabite zahtevo GET, da pridobite seznam vseh razpoložljivih pravil, pravil v naboru pravil ali naborov pravil s klicem API-ja [Geographical URI]/api/rule. Obstaja nekaj različic klicanja tega API-ja, vendar je najpogostejša uporaba pridobivanje seznama pravil za določen nabor pravil.

opomba,

Za ta API je potreben žeton OAuth.

Glave

Imenu Vnesi Pričakovana vrednost Obvezno?
Sprejmi jezik string Koda jezika (na primer en-US). Privzeta nastavitev je en-US. ne

Parametri

Imenu Vnesi Pričakovana vrednost Obvezno?
ruleset string Ime ali ID nabora pravil ali seznam ID-jev nabora pravil ali imena, ločena z vejico ali podpičjem (na primer »Preverjevalnik rešitev«). ne
includeMessageFormats logična vrednost Ko je nastavljeno na true, je seznam možnih različic sporočil vključen v rezultate zahtev za jezike, če so na voljo. Ta seznam je uporaben za prevode v več jezikov. Če ni potreben, tega parametra ne navedite ali navedite false kot vrednost, saj ta parameter poveča velikost odgovora in lahko podaljša čas obdelave. ne

Pričakovani odzivi

Koda stanja HTTP Scenarij Rezultat
200 Najdenih je bil en rezultat ali več Oglejte si primer kasneje v tem članku. Vrne se lahko en rezultat ali več.
204 Najden ni bil noben rezultat V telesu odziva ni rezultatov.
401 Preverjanje pristnosti ni uspelo V telesu odziva ni rezultatov.

Pričakovano telo odziva

Naslednja tabela prikazuje strukturo odgovora za vsako zahtevo (samo odgovor HTTP 200).

Lastnost Vrsti Pričakovana vrednost Obvezno?
koda string Identifikator pravila, ki ga včasih imenujemo ID pravila. Da
povzetek string Povzetek pravila. Da
opis string Podrobnejši opis pravila. Da
guidanceUrl URI URL, v katerem lahko najdete objavljena navodila. V nekaterih primerih morda ni posebnega podpornega članka z navodili. Da
vključi boolean Signali storitvi, da je treba v analizo vključiti pravilo. Ta vrednost je true za ta API. No
messageTemplates polje Vrednost te lastnosti je vključena samo, kadar je includeMessageFormatstrue. Ne
messageTemplates.ruleId string Vrne isto vrednost ID-ja kot lastnost code. Da
messageTemplates.messageTemplateId string Identifikator, ki se uporablja v poročilu SARIF (oblika zapisa izmenjave rezultatov statične analize), da sporoči različico sporočila o težavi za pravilo. Da
messageTemplates.messageTemplate string Besedilo različice sporočila za scenarij težave, o katerem poroča pravilo. To besedilo je formatni niz, ki lahko vsebuje žetone, v katerih je mogoče argumente iz poročila SARIF uporabiti za izdelavo podrobnega sporočila. Da

Primer: pridobivanje pravil za nabor pravil v drugem jeziku

Ta primer vrne podatke za vsa pravila v naboru pravil Pregledovalnik rešitev v francoskem jeziku. Če je želeni jezik angleščina, enostavno odstranite glavo »Sprejmi jezik«.

Zahteva

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

Response

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

Primer: pridobivanje vseh

Ta primer vrne podatke za vsa razpoložljiva pravila.

Zahteva

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

Response

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

Primer: pridobivanje nabora pravil z oblikami zapisa sporočil

Ta primer vrne podatke za vsa pravila v naboru pravil Pregledovalnik rešitev v francoskem jeziku. Če je želeni jezik angleščina, enostavno odstranite glavo »Sprejmi jezik«.

Zahteva

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

Response

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

Glejte tudi

Uporaba spletnega API-ja pregledovalnika za Power Apps
Pridobivanje seznama nizov pravil
Prenos datoteke
Priklic analize
Preverjanje stanja analize