Reeglite loendi toomine
Reeglid rühmitatakse reeglistiku abil. Reeglit ei pruugi olla reeglistikus ning see võib olla mitmes reeglistikus. Kõigi saadaolevate reeglite, reeglistikku kuuluvate reeglite või reeglistike loendi saamiseks taotluse GET abil kutsuge API [Geographical URI]/api/rule. Selle API kutsumiseks on mõned variandid, kuid kõige levinum variant on konkreetse reeglistiku reeglite loendi toomine.
Märkus.
See API nõuab OAuthi sõne.
Päised
| Nimetus | Tüüp | Eeldatav väärtus | Kas on nõutav? |
|---|---|---|---|
| Aktsepteeri – keel | string | Keelekood (näiteks en-US). Vaikekeel on en-US. | ei |
Parameetrid
| Nimetus | Tüüp | Eeldatav väärtus | Kas on nõutav? |
|---|---|---|---|
| reeglistik | string | Reeglistiku nimi või ID või reeglistiku ID-de loend või koma või semikooloniga eraldatud nimed (nt "Lahendusekontroll"). | ei |
| includeMessageFormats | bool | Kui sätte väärtuseks on seatud true, kaasatakse võimalike sõnumite variatsioonide loend keelte taotluste tulemustesse, kui see on saadaval. See loend on kasulik mitmesse keelde tõlkimiseks. Kui seda pole vaja, siis ärge sisestage seda parameetrit ega sisestage false väärtusena, kuna see parameeter suurendab vastuse suurust ja võib pikendada töötlemisaega. |
ei |
Eeldatavad vastused
| HTTP-olekukood | Stsenaarium | Tulemus |
|---|---|---|
| 200 | Leiti üks või mitu tulemit | Vaadake näidet selle artikli allpool. Üks või mitu tulemust võidakse tagastada. |
| 204 | Tulemeid ei leitud | Vastuse sisu ei sisalda tulemusi. |
| 401 | Autentimine nurjus | Vastuse sisu ei sisalda tulemusi. |
Eeldatav vastuse sisu
Järgmises tabelis on esitatud iga taotluse vastuse struktuur (ainult vastus HTTP 200).
| Atribuut | Tüüp | Eeldatav väärtus | Kas on nõutav? |
|---|---|---|---|
| kood | string | Reegli identifikaator, mida mõnikord nimetatakse reegli ID-ks. | Ja |
| Kokkuvõte | string | Reegli kokkuvõte. | Ja |
| kirjeldus | string | Reegli täpsem kirjeldus. | Ja |
| guidanceUrl | URI | Avaldatud juhiste otsimise URL. Võib esineda juhtumeid, kus pole spetsiaalset toetavat juhendavat artiklit. | Ja |
| kaasa | boolean | Annab teenusele märku, et reegel tuleb kaasata analüüsi. See väärtus on true selle API jaoks. |
No |
| messageTemplates | array | See atribuudi väärtus kaasatakse ainult siis, kui includeMessageFormats on true. |
Ei |
| messageTemplates.ruleId | string | Tagastab sama ID-väärtuse nagu atribuut code. |
Ja |
| messageTemplates.messageTemplateId | string | Identifikaator, mida kasutatakse staatilise analüüsi tulemuste vahetuse vormingu (SARIF) aruandes, et anda märku reegli probleemikohase sõnumi variatsioonist. | Ja |
| messageTemplates.messageTemplate | string | Probleemikohase sõnumi variatsiooni tekst, millest reegel teatab. See tekst on vormingustring, mis võib sisaldada märke, milles SARIF-aruandes esitatud argumente saab kasutada üksikasjaliku sõnumi koostamiseks. | Ja |
Näide: reeglistiku reeglite toomine mõnes muus keeles
Selles näites tagastatakse lahendusekontrollija reeglistiku kõigi reeglite andmed prantsuse keeles. Kui soovitud keel on inglise keel, siis eemaldage lihtsalt päis Aktsepteeri – keel.
Taotlus
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": ""
}
},
...
]
Näide: too kõik
Selles näites tagastatakse kõigi saadaolevate reeglite andmed.
Taotlus
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": ""
}
},
...
]
Näide: too sõnumi vormingutega reeglistik
Selles näites tagastatakse lahendusekontrollija reeglistiku kõigi reeglite andmed prantsuse keeles. Kui soovitud keel on inglise keel, siis eemaldage lihtsalt päis Aktsepteeri – keel.
Taotlus
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."
}
]
},
...
]
Vt ka
Veebi-API Power Apps kontrolli kasutamine
Reeglistiku loendi toomine
Laadi fail üles
Analüüsi käivitamine
Analüüsi oleku kontrollimine
Tagasiside
Varsti tulekul: 2024. aasta jooksul tühistame GitHubi probleemide funktsiooni sisutagasiside mehhanismina ja asendame selle uue tagasisidesüsteemiga. Lisateabe saamiseks vt https://aka.ms/ContentUserFeedback.
Esita ja vaata tagasisidet