Hämta listan med regler

Artikel
10/16/2024

Regler grupperas tillsammans med en regeluppsättning. En regel kan inte finnas i en eller flera regeluppsättningar. Använd en GET-förfrågan om du vill hämta en lista över alla tillgängliga regler, regler i en regeluppsättning, eller regeluppsättningar genom att anropa API:n [Geographical URI]/api/rule. Det finns några varianter av att anropa API:n, men den vanligaste användningen är att hämta regellistan för en specifik regeluppsättning.

Obs

Det här API:et kräver en OAuth token.

Sidhuvuden

Name	Type	Förväntat värde	Obligatorisk?
Godkänn-språk	sträng	Språkkoden (till exempel en-US). Standardalternativet är en-US.	Nej

Parametrar

Namn	Typ	Förväntat värde	Obligatorisk?
ruleset	sträng	Namn eller ID för en regeluppsättning eller en lista över ID för regeluppsättningar, eller namn avgränsade med kommatecken eller semikolon (t.ex. "lösningskontroll").	Nej
includeMessageFormats	bool	Om detta alternativ är inställt som `true` visas en lista över möjliga meddelandeskillnader i resultatet för de begärda språken (om tillgängliga). Denna lista är användbar för översättningar på flera språk. Om detta inte behövs anger du inte parametern eller anger `false` som värde, detta eftersom denna parameter utökar svarets omfång och kan förlänga bearbetningstiden.	Nej

Förväntade svar

HTTP-statuskod	Scenario	Resultat
200	Ett eller flera resultat hittades	Se exemplet längre fram i den här artikeln. Ett eller flera resultat kan returneras.
204	Inga resultat hittades	Inga resultat i svarstexten.
401	Autentiseringen misslyckades	Inga resultat i svarstexten.

Förväntat svar

I följande tabell anges svarsstrukturen för respektive förfrågan (endast HTTP 200-svar).

Egenskap	Typ	Förväntat värde	Obligatorisk?
kod	sträng	Regelns identifierare, men kallas även regel-ID.	Ja
Sammanfattning	sträng	En sammanfattning av regeln	Ja
description	sträng	Mer detaljerad beskrivning av regeln.	Ja
guidanceUrl	URI	Den URL där du hittar publicerad vägledning. Det kan finnas fall där det inte finns någon särskild vägledningsartikel för support.	Ja
inkludera	boolean	Signalerar till tjänsten att regeln ska tas med i analysen. Värdet är `true` för detta API.	Nej
messageTemplates	matris	Detta egenskapsvärde ingår endast när `includeMessageFormats` är `true`.	Nej
messageTemplates.ruleId	sträng	Returnerar samma ID-värde som egenskapen `code`.	Ja
messageTemplates.messageTemplateId	sträng	En identifierare som används i SARIF-rapporten (Static Analysis Result Interchange Format) för att signalera en variant av ett ärendemeddelande för regeln.	Ja
messageTemplates.messageTemplate	sträng	Texten i meddelandevariationen för det ärendescenario som regeln rapporterar. Denna text är en formatsträng som kan innehålla tokens där argument som ges i SARIF-rapporten kan användas för att skapa ett detaljerat meddelande.	Ja

Exempel: Hämta regler för en regeluppsättning på ett annat språk

I det här exemplet returneras data för alla regler i regeluppsättningen Solution Checker på franska. Om det önskade språket är engelska tar du bara bort huvudet för "Accept-Language".

Begäran

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

svar

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

Exempel: Hämta alla

I det här exemplet returneras data för alla tillgängliga regler.

Begäran

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

svar

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

Exempel: Hämta för en regeluppsättning med meddelandeformat

I det här exemplet returneras data för alla regler i regeluppsättningen Solution Checker på franska. Om det önskade språket är engelska tar du bara bort huvudet för "Accept-Language".

Begäran

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

svar

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

Se även

Använda webb-API:et för Power Apps kontroll
Hämta listan med regeluppsättningar
Ladda upp en fil
Anropa analys
Kontrollera analysstatus

Dela via

Hämta listan med regler

Sidhuvuden

Parametrar

Förväntade svar

Förväntat svar

Exempel: Hämta regler för en regeluppsättning på ett annat språk

Exempel: Hämta alla

Exempel: Hämta för en regeluppsättning med meddelandeformat

Se även

Feedback

Ytterligare resurser