Sääntöluettelon noutaminen

Artikkeli
02/07/2024

Säännöt ryhmitellään yhteen sääntöjoukkoa käyttämällä. Sääntö voi olla itsenäinen tai kuulua useisiin tietojoukkoihin. GET-pyynnön avulla voit hankkia luettelon kaikista käytettävissä olevista säännöistä, sääntöjoukossa olevista säännöistä tai sääntöjoukoista kutsumalla ohjelmointirajapintaa [Geographical URI]/api/rule. Tämän ohjelmointirajapinnan kutsumiseen on muutamia muunnelmia, mutta yleisin käyttötapa on hakea tietyn sääntöjoukon sääntöjen luettelo.

Otsikot

Name	Type	Odotettu arvo	Onko pakollinen?
Accept-Language	string	Kielikoodi (esimerkiksi en-US). Oletusarvona on en-US.	ei

Parametrit

Name	Type	Odotettu arvo	Onko pakollinen?
ruleset	string	Sääntöjoukon nimi tai tunnus sääntöjoukkojen tunnusten luettelo tai nimiä, jotka on eroteltu pilkulla tai puolipisteillä (esimerkiksi ratkaisun tarkistustoiminto).	ei
includeMessageFormats	bool	Kun arvona on `true`, kielipuuntojen tuloksiin sisällytetään mahdollisten sanomavariaatioiden luettelo, jos käytettävissä. Tästä luettelosta on hyötyä käännöksissä useille kielille. Jos sitä ei tarvita, älä anna tätä parametria tai määritä sen arvoksi `false`, koska tämä parametri suurentaa vastauksen kokoa ja voi pidentää käsittelyaikaa.	ei

Odotetut vastaukset

HTTP-tilakoodi	Skenaario	Result
200	Vähintään yksi tulos löytyi	Katso esimerkki jäljempänä tässä artikkelissa. Palautus voi sisältää yhden tai useamman tuloksen.
204	Tuloksia ei löytynyt	Vastaustekstissä ei ole tuloksia.
401	Todennus epäonnistui	Vastaustekstissä ei ole tuloksia.

Odotettu vastausteksti

Seuraavassa taulukossa esitetään kunkin pyynnön vastauksen rakenne (vain HTTP 200-vastaus).

Ominaisuus	Laji	Odotettu arvo	Onko pakollinen?
koodi	string	Säännön tunnus, jota kutsutaan joskus sääntötunnukseksi.	Kyllä
Yhteenveto	string	Säännön yhteenveto.	Kyllä
description	string	Tarkempi kuvaus säännöstä.	Kyllä
guidanceUrl	URI	URL-osoite, josta julkaistut ohjeet löytyvät. Joissakin tapauksissa ei ole erityistä tukiohjeaihetta.	Kyllä
include	boolean	Ilmoittaa palvelulle, että sääntö sisällytetään analyysiin. Tämän ohjelmointirajapinnan arvon on `true`.	Ei
messageTemplates	matriisi	Ominaisuuden arvo sisällytetään vain, kun `includeMessageFormats` on `true`.	Ei
messageTemplates.ruleId	string	Palauttaa saman tunnusarvon kuin `code`-ominaisuus.	Kyllä
messageTemplates.messageTemplateId	string	Static Analysis Results Interchange Format (SARIF) -raportissa käytetty tunnus, jolla ilmoitetaan säännön ongelmasanomavariaatiosta.	Kyllä
messageTemplates.messageTemplate	string	Säännön raportoiman ongelmaskenaarion sanomavariaatoin teksti. Tämä teksti on muotomerkkijono, joka voi sisältää tunnuksia, joissa SARIF-raportissa esitettyjä argumentteja voidaan käyttää yksityiskohtaisen sanoman koostamiseen.	Kyllä

Esimerkki: nouda sääntöjä sääntöjoukolle toisella kielellä

Tämä esimerkki palauttaa tietoja kaikille Ratkaisun tarkistus -sääntöjoukon säännöille ranskaksi. Jos haluttu kieli on englanti, poista vain Accept-Language-otsikko.

Pyyntö

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

Esimerkki: nouda kaikki

Tämä esimerkki palautta tietoja kaikille saatavilla oleville säännöille.

Pyyntö

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

Esimerkki: nouda sääntöjoukkoa, jossa on sanomamuotoja

Tämä esimerkki palauttaa tietoja kaikille Ratkaisun tarkistus -sääntöjoukon säännöille ranskaksi. Jos haluttu kieli on englanti, poista vain Accept-Language-otsikko.

Pyyntö

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

Katso myös

Power Apps -tarkistustoiminnon verkko-ohjelmointirajapinnan käyttäminen
Sääntöjoukkoluettelon noutaminen
Tiedoston lataaminen
Analyysin käynnistäminen
Analyysin tilan tarkistaminen

Sääntöluettelon noutaminen

Otsikot

Parametrit

Odotetut vastaukset

Odotettu vastausteksti

Esimerkki: nouda sääntöjä sääntöjoukolle toisella kielellä

Esimerkki: nouda kaikki

Esimerkki: nouda sääntöjoukkoa, jossa on sanomamuotoja

Katso myös

Lisäresursseja