Отримання списку правил
Правила групуються разом за допомогою набору правил. Правило може не належати до набору правил або належати до декількох наборів правил. Скористайтеся запитом GET для отримання списку всіх доступних правил, правил у наборі правил або наборів правил за допомогою виклику API [Geographical URI]/api/rule. Існує кілька варіантів виклику цього API, проте найпоширенішим використанням є отримання списку правил для певного набору правил.
Нотатка
Для цього API потрібен токен. OAuth
Заголовки
| Ім'я | Ввести | Очікуване значення | Обов’язкове? |
|---|---|---|---|
| Accept-Language | рядок | Код мови (наприклад, en-US). Значення за замовчуванням: en-US. | ні |
Параметри
| Ім'я | Ввести | Очікуване значення | Обов’язкове? |
|---|---|---|---|
| набір правил | string | Ім’я або ідентифікатор набору правил або список ідентифікаторів наборів правил, або імена, розділені комою або крапкою з комою (наприклад, "Засіб перевірки рішень"). | ні |
| includeMessageFormats | логічний | Якщо для параметра задано значення true, список можливих варіантів повідомлень буде додано до результатів запитів мов, якщо це доступно. Цей список корисний для перекладів на кілька мов. Якщо він не потрібен, то не вказуйте цей параметр або не вказуйте false як значення, оскільки цей параметр збільшує розмір відповіді і може збільшити час обробки. |
ні |
Очікувані відповіді
| Код стану HTTP | Сценарій | Результат |
|---|---|---|
| 200 | Знайдено один або кілька результатів | Дивіться приклад далі в цій статті. Може бути повернуто один або кілька результатів. |
| 204 | Результати не знайдено | Немає результатів у тексті відповіді. |
| 401 | Автентифікацію не пройдено | Немає результатів у тексті відповіді. |
Текст очікуваної відповіді
У наведеній нижче таблиці розглядається структура відповіді для кожного запиту (відповідь лише HTTP 200).
| Властивість | Тип | Очікуване значення | Обов’язкове? |
|---|---|---|---|
| код | string | Ідентифікатор правила, який іноді називають ІД правила. | Так |
| Зведення | рядок | Короткий виклад правила. | Так |
| опис | рядок | Більш детальний опис правила. | Так |
| guidanceUrl | URI | URL-адреса, за якою можна знайти опубліковані вказівки. У деяких випадках може не бути спеціальної допоміжної статті. | Так |
| включити | boolean | Повідомляє службу, що це правило слід включити в аналіз. Це значення для true цього API. |
No |
| messageTemplates | масив | Це значення властивості додається, лише коли параметр includeMessageFormats має значення true. |
Ні |
| messageTemplates.ruleId | string | Повертає таке саме значення ідентифікатора, що й властивість code. |
Так |
| messageTemplates.messageTemplateId | string | Ідентифікатор, який використовується в звіті у форматі Static Analysis Results Interchange Format (SARIF), щоб відобразити варіант повідомлення про помилку для цього правила. | Так |
| messageTemplates.messageTemplate | string | Текст варіанта повідомлення для сценарію помилки, про яку повідомляє правило. Цей текст є рядком формату, який може містити токени, в яких аргументи, надані у звіті SARIF, можуть бути використані для побудови детального повідомлення. | Так |
Приклад: отримання правил для набору правил іншою мовою
Цей приклад повертає дані для всіх правил в наборі правил Засобу перевірки рішень на французькій мові. Якщо потрібна англійська мова, то просто видаліть заголовок Accept-Language.
Просити
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
відповідь
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 веб-API чекера
Отримання списку наборів правил
Завантажити файл
Аналіз виклику
Перевірка статусу аналізу