Dohvaćanje popisa pravila

Pravila se grupiraju pomoću skupa pravila. Pravilo ne mora biti u skupu pravila ili može biti u više skupova. Koristite GET zahtjev za dobivanje popisa svih dostupnih pravila, pravila u skupu pravila ili skupova pravila pozivajući API [Geographical URI]/api/rule. Nekoliko je varijacija pozivanja ovog API-ja, međutim, najčešća se upotreba odnosi na dohvaćanje popisa pravila za određeni skup pravila.

Napomena

Ovaj API zahtijeva OAuth token.

Zaglavlja

Ime/naziv Tip Očekivana vrijednost Obvezno?
Accept-Language niz Kôd jezika (na primjer, en-US). Prema zadanim je postavkama en-US. ne

Parametri

Ime/naziv Tip Očekivana vrijednost Obvezno?
skup pravila niz Naziv ili ID skupa pravila ili popis ID-ova skupa pravila ili imena odvojenih zarezom ili točkom sa zarezom (na primjer, "Alat za provjeru rješenja"). ne
includeMessageFormats bool Kad je postavljeno na true, popis mogućih varijacija poruka uvrštava se u rezultate zahtjeva jezika, ako su dostupni. Ovaj je popis koristan za prijevode na više jezika. Ako nije potrebno, nemojte navesti ovaj parametar ili navesti false kao vrijednost jer ovaj parametar povećava veličinu odgovora i može povećati vrijeme obrade. ne

Očekivani odgovori

HTTP šifra statusa Scenarij Rezultat
200 Pronađen je jedan ili više rezultata Pogledajte primjer kasnije u ovom članku. Može se vratiti jedan ili više rezultata.
204 Nije pronađen nijedan rezultat Nema rezultata u tijelu odgovora.
401 Provjera autentičnosti nije uspjela Nema rezultata u tijelu odgovora.

Tijelo očekivanog odgovora

U sljedećoj tablici je opisana struktura odgovora za svaki zahtjev (samo odgovor HTTP 200).

Svojstvo Tip Očekivana vrijednost Obvezno?
kod niz Identifikator pravila, koji se ponekad naziva i ID-om pravila. Jest
Sažetak niz Sažetak pravila. Jest
opis niz Detaljniji opis pravila. Jest
guidanceUrl URI URL u kojem možete pronaći objavljene smjernice. Mogu postojati neki slučajevi u kojima ne postoji poseban članak o popratnim smjernicama. Jest
uključi boolean Signali usluzi da je pravilo potrebno uključiti u analizu. Ova vrijednost je true za ovaj API. No
messageTemplates polje Vrijednost ovog svojstva uključena je samo kada je includeMessageFormatstrue. No
messageTemplates.ruleId niz Vraća istu vrijednost ID-a kao i svojstvo code. Jest
messageTemplates.messageTemplateId niz Identifikator koji se koristi u izvješću Format razmjene rezultata statičke analize (SARIF) radi signaliziranja varijacije poruke o problemu za pravilo. Jest
messageTemplates.messageTemplate niz Tekst varijacije poruke za scenarij problema o kojem pravilo izvješćuje. Ovaj tekst je niz oblika koji može sadržavati tokene u kojima se argumenti navedeni u SARIF izvješću mogu koristiti za izradu detaljne poruke. Jest

Primjer: dohvaćanje pravila za skup pravila na nekom drugom jeziku

U ovom se primjeru podaci vraćaju za sva pravila u skupu pravila Provjera rješenja na francuskom jeziku. Ako je željeni jezik engleski, tada samo uklonite zaglavlje Accept-Language.

Zahtjev

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

Odgovor

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

Primjer: dohvaćanje svega

U ovom primjeru se vraćaju podaci za sva dostupna pravila.

Zahtjev

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

Odgovor

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

Primjer: dohvaćanje za skup pravila s formatima poruka

U ovom se primjeru podaci vraćaju za sva pravila u skupu pravila Provjera rješenja na francuskom jeziku. Ako je željeni jezik engleski, tada samo uklonite zaglavlje Accept-Language.

Zahtjev

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

Odgovor

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

Pogledajte također

Korištenje web-API-ja za provjeru Power Apps
Dohvaćanje popisa skupova pravila
Prijenos datoteke
Analiza pozivanja
Provjera statusa analize

  • Last updated on