Kārtulu saraksta izgūšana
Kārtulas tiek grupētas kopā, izmantojot kārtulu kopu. Kārtula nevar atrasties nevienā kārtulu kopā vai vairākās kārtulu kopās. Izmantojiet GET pieprasījumu, lai iegūtu visu pieejamo kārtulu sarakstu, kārtulas kārtulu kopā vai kārtulu kopas, izsaucot API [Geographical URI]/api/rule. Ir dažas variācijas par šī API izsaukšanu, tomēr visizplatītākais lietojums ir izgūt noteiktu kārtulu sarakstu noteiktai kārtulu kopai.
Piezīmes
Šim API nav nepieciešams OAuth marķieris.
Virsraksti
| Nosaukums/vārds | Tipi | Paredzētā vērtība | Vai jānorāda obligāti? |
|---|---|---|---|
| Accept-Language | string | Valodas kods (piemēram, en-US). Noklusējuma iestatījums ir en-US. | nē |
Parameters
| Nosaukums/vārds | Tipi | Paredzētā vērtība | Vai jānorāda obligāti? |
|---|---|---|---|
| kārtulu kopa | string | Kārtulu kopas nosaukums vai ID, vai kārtulu kopas ID saraksts, vai nosaukumi, kas atdalīti ar komatu vai semikolu (piemēram, "risinājumu pārbaudītājs"). | nē |
| includeMessageFormats | bool | Ja iestatījums ir true, iespējamo ziņojumu variāciju saraksts tiek iekļauts valodu pieprasījumu rezultātos, ja tas ir pieejams. Šis saraksts ir noderīgs tulkojumiem vairākās valodās. Ja tas nav nepieciešams, nenorādiet šo parametru un nenorādiet false kā vērtību, jo šis parametrs palielina atbildes lielumu un var palielināt apstrādes laiku. |
nē |
Paredzamās atbildes
| HTTP statusa kods | Situācija | Rezultāts |
|---|---|---|
| Vairāk nekā 200 | Tika atrasts viens vai vairāki rezultāti | Skatiet piemēru tālāk šajā rakstā. Var atgriezt vienu vai vairākus rezultātus. |
| 204 | Netika atrasts neviens rezultāts. | Atbildes struktūrā rezultātu nav. |
| 401 | Autentifikācija neizdevās | Atbildes struktūrā rezultātu nav. |
Paredzamo atbilžu struktūra
Tālāk sniegtajā tabulā ir aprakstīta atbildes struktūra katram pieprasījumam (tikai HTTP 200 atbildei).
| Rekvizīts | Veids | Paredzētā vērtība | Vai jānorāda obligāti? |
|---|---|---|---|
| kods | string | Kārtulas identifikators, ko dažkārt dēvē par Kārtulas ID. | Jā |
| Kopsavilkums | string | Noteikuma kopsavilkums. | Jā |
| apraksts | string | Kārtulas detalizētāks apraksts. | Jā |
| guidanceUrl | URI | URL, kurā meklēt publicētos norādījumus. Var būt gadījumi, kad nav īpaša atbalsta vadlīniju raksta. | Jā |
| include | boolean | Signāli uz servisu, ka kārtula ir jāiekļauj analīzē. Šī vērtība ir true šai API. |
Nē. |
| messageTemplates | masīvs | Šī rekvizīta vērtība tiek iekļauta tikai tad, kad includeMessageFormats ir true. |
Nē |
| messageTemplates.ruleId | string | Atgriež tādu pašu ID vērtību kā code rekvizītam. |
Jā |
| messageTemplates.messageTemplateId | string | Identifikators, ko izmanto Statiskās analīzes rezultātu apmaiņas formātā (SARIF), lai brīdinātu par problēmas ziņojuma variantu kārtulai. | Jā |
| messageTemplates.messageTemplate | string | Ziņojuma varianta teksts, kas tiek lietots kārtulas atskaitēs. Šis teksts ir formāta virkne, kurā var būt marķieri, kuros SARIF atskaitē sniegtos argumentus var izmantot, lai izveidotu detalizētu ziņojumu. | Jā |
Piemērs: izgūt kārtulas kārtulu kopai citā valodā
Šajā piemērā tiek atgriezti dati par visām kārtulām Risinājumu pārbaudītāja kārtulu kopā franču valodā. Ja vēlamā valoda ir angļu valoda, noņemiet Accept-Language galveni.
Pieprasījums
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": ""
}
},
...
]
Piemērs: izgūt visus
Šajā piemērā tiek atgriezti visu pieejamo kārtulu dati.
Pieprasījums
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": ""
}
},
...
]
Piemērs: izgūt kārtulu kopai ar ziņojumu formātiem
Šajā piemērā tiek atgriezti dati par visām kārtulām Risinājumu pārbaudītāja kārtulu kopā franču valodā. Ja vēlamā valoda ir angļu valoda, noņemiet Accept-Language galveni.
Pieprasījums
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."
}
]
},
...
]
Skatiet arī
Izmantot Power Apps pārbaudītāja tīmekļa API
Kārtulu kopu saraksta izgūšana
Faila augšupielādēšana
Analīzes izsaukšana
Analīzes statusa pārbaude
Atsauksmes
Drīzumā: 2024. gada laikā mēs pakāpeniski pārtrauksim izmantot “GitHub problēmas” kā atsauksmju par saturu mehānismu un aizstāsim to ar jaunu atsauksmju sistēmu. Papildinformāciju skatiet: https://aka.ms/ContentUserFeedback.
Iesniegt un skatīt atsauksmes par