Преузимање листе правила
Правила су груписана заједно помоћу скупа правила. Правило може бити без скупа правила или у више скупова правила. Користите GET захтев да добијете листу свих доступних правила, правила у скуповима правила или скупова правила позивањем API-ја [Geographical URI]/api/rule. Постоји неколико варијација за позивање овог API-ја, међутим, најчешћа употреба је преузимање листе правила за одређени скуп правила.
Белешка
Овај АПИ захтева OAuth токен.
Заглавља
| Именуј | Тип | Очекивана вредност | Да ли је потребно? |
|---|---|---|---|
| Accept-Language | string | Код језика (на пример, ср-УС). Подразумевани језик је en-US. | не |
Параметри
| Именуј | Тип | Очекивана вредност | Да ли је потребно? |
|---|---|---|---|
| ruleset | string | Име или ИД скупа правила или списак ИД-ова скупова правила, или имена одвојена зарезом или тачком и зарезом (на пример, "Провера решења"). | не |
| includeMessageFormats | bool | Када је постављено на true, листа могућих варијација порука је укључена у резултате захтева језика, ако су доступни. Ова листа је корисна за преводе на више језика. Ако није потребно, онда немојте дати овај параметар или дати false као вредност јер овај параметар повећава величину одговор и може повећати време обраде. |
не |
Очекивани одговори
| Шифра HTTP статуса | Сценарио | Резултат |
|---|---|---|
| 200 | Пронађен је један резултат или више њих | Погледајте пример касније у овом чланку. Може се вратити један или више резултата. |
| 204 | Није пронађен ниједан резултат | Нема резултата у телу одговора. |
| 401. | Потврда идентитета није успела | Нема резултата у телу одговора. |
Очекивано тело одговора
Следећа табела приказује структуру одговора за сваки захтев (само одговор HTTP 200).
| Својство | Тип | Очекивана вредност | Да ли је потребно? |
|---|---|---|---|
| code | string | Идентификатор правила, који се понекад назива и ID правила. | Да |
| Резиме | string | Резиме правила. | Да |
| опис | string | Детаљнији опис правила. | Да |
| guidanceUrl | URI | URL адреса на којој можете пронаћи објављене смернице. Могу постојати неки случајеви у којима не постоји посебан чланак о пратећим упутствима. | Да |
| include | boolean | Сигнали услузи да правило треба да буде укључено у анализу. Ова вредност је true за овај АПИ. |
No |
| messageTemplates | array | Вредност овог својства је укључена само када includeMessageFormats има вредност true. |
Не |
| messageTemplates.ruleId | string | Враћа исту вредност ID-а као и својство code. |
Да |
| messageTemplates.messageTemplateId | string | Идентификатор који се користи у извештају о формату размене резултата статичке анализе (SARIF) да сигнализира варијацију поруке о проблему за правило. | Да |
| messageTemplates.messageTemplate | string | Текст варијације поруке за сценарио проблема о којем правило извештава. Овај текст је стринг формата који може да садржи токене у којима се аргументи наведени у САРИФ извештају могу користити за конструисање детаљне поруке. | Да |
Пример: преузмите правила за скуп правила на другом језику
Овај пример враћа податке за сва правила у скуп правила Провера решења на француском језику. Ако је жељени језик енглески, онда само уклоните заглавље Accept-Language.
Захтев
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
одговор
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": ""
}
},
...
]
Пример: преузми све
Овај пример враћа податке за све доступна правила.
Захтев
GET [Geographical URI]/api/rule?api-version=2.0
Accept: application/json
Content-Type: application/json; charset=utf-8
одговор
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": ""
}
},
...
]
Пример: преузмите скуп правила са форматима порука
Овај пример враћа податке за сва правила у скуп правила Провера решења на француском језику. Ако је жељени језик енглески, онда само уклоните заглавље Accept-Language.
Захтев
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
одговор
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."
}
]
},
...
]
Такође погледајте
Користите проверу Power Apps веб АПИ
Преузмите листу скупова правила
Отпремите датотеку
Позивање на анализу
Провера статуса анализе