Preuzimanje liste pravila
Pravila su grupisana zajedno pomoću skupa pravila. Pravilo može biti bez skupa pravila ili u više skupova pravila. Koristite GET zahtev da dobijete listu svih dostupnih pravila, pravila u skupovima pravila ili skupova pravila pozivanjem API-ja [Geographical URI]/api/rule. Postoji nekoliko varijacija za pozivanje ovog API-ja, međutim, najčešća upotreba je preuzimanje liste pravila za određeni skup pravila.
Belešku
Ovaj API zahteva OAuth token.
Zaglavlja
| Imenuj | Tip | Očekivana vrednost | Da li je potrebno? |
|---|---|---|---|
| Accept-Language | string | Kod jezika (na primer, sr-US). Podrazumevani jezik je en-US. | ne |
Parametri
| Imenuj | Tip | Očekivana vrednost | Da li je potrebno? |
|---|---|---|---|
| ruleset | string | Ime ili ID skupa pravila ili spisak ID-ova skupova pravila, ili imena odvojena zarezom ili tačkom i zarezom (na primer, "Provera rešenja"). | ne |
| includeMessageFormats | bool | Kada je postavljeno na true, lista mogućih varijacija poruka je uključena u rezultate zahteva jezika, ako su dostupni. Ova lista je korisna za prevode na više jezika. Ako nije potrebno, onda nemojte navesti ovaj parametar ili dati false kao vrednost jer ovaj parametar povećava veličinu odgovor i može povećati vreme obrade. |
ne |
Očekivani odgovori
| Šifra HTTP statusa | Scenario | rezultat |
|---|---|---|
| 200 | Pronađen je jedan rezultat ili više njih | Pogledajte primer kasnije u ovom članku. Može se vratiti jedan ili više rezultata. |
| 204 | Nije pronađen nijedan rezultat | Nema rezultata u telu odgovora. |
| 401 | Potvrda identiteta nije uspela | Nema rezultata u telu odgovora. |
Očekivano telo odgovora
Sledeća tabela prikazuje strukturu odgovora za svaki zahtev (samo odgovor HTTP 200).
| Svojstvo | Tip | Očekivana vrednost | Da li je potrebno? |
|---|---|---|---|
| code | string | Identifikator pravila, koji se ponekad naziva i ID pravila. | Da |
| Rezime | string | Rezime pravila. | Da |
| opis | string | Detaljniji opis pravila. | Da |
| guidanceUrl | URI | URL adresa na kojoj možete pronaći objavljene smernice. Mogu postojati neki slučajevi u kojima ne postoji poseban članak o pratećim uputstvima. | Da |
| include | boolean | Signali usluzi da pravilo treba da bude uključeno u analizu. Ova vrednost je true za ovaj API. |
No |
| messageTemplates | array | Vrednost ovog svojstva je uključena samo kada includeMessageFormats ima vrednost true. |
Ne |
| messageTemplates.ruleId | string | Vraća istu vrednost ID-a kao i svojstvo code. |
Da |
| messageTemplates.messageTemplateId | string | Identifikator koji se koristi u izveštaju o formatu razmene rezultata statičke analize (SARIF) da signalizira varijaciju poruke o problemu za pravilo. | Da |
| messageTemplates.messageTemplate | string | Tekst varijacije poruke za scenario problema o kojem pravilo izveštava. Ovaj tekst je string formata koji može da sadrži tokene u kojima se argumenti navedeni u SARIF izveštaju mogu koristiti za konstruisanje detaljne poruke. | Da |
Primer: preuzmite pravila za skup pravila na drugom jeziku
Ovaj primer vraća podatke za sva pravila u skup pravila Provera rešenja na francuskom jeziku. Ako je željeni jezik engleski, onda samo uklonite zaglavlje Accept-Language.
Zahtev
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
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": ""
}
},
...
]
Primer: preuzmi sve
Ovaj primer vraća podatke za sve dostupna pravila.
Zahtev
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": ""
}
},
...
]
Primer: preuzmite skup pravila sa formatima poruka
Ovaj primer vraća podatke za sva pravila u skup pravila Provera rešenja na francuskom jeziku. Ako je željeni jezik engleski, onda samo uklonite zaglavlje Accept-Language.
Zahtev
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."
}
]
},
...
]
Takođe pogledajte
Koristite proveru Power Apps veb API
Preuzmite listu skupova pravila
Otpremite datoteku
Pozivanje na analizu
Provera statusa analize