Abrufen der Regelliste

Artikel
10/16/2024

Regeln werden zusammen mit einem Regelsatz gruppiert. Eine Regel kann in keinem Regelsatz oder in mehreren Regelsätzen enthalten sein. Verwenden Sie eine GET-Abfrage, um eine Liste aller verfügbaren Regeln, Regeln in einem Regelsatz oder in Regelsätzen zu ermitteln, indem Sie die API [Geographical URI]/api/rule aufrufen. Es gibt einige Variationen zum Anrufen dieser API, jedoch wird am häufigsten die Regelliste für einen bestimmten Regelsatz abgerufen.

Anmerkung

Diese API erfordert ein OAuth Token.

Kopfzeile

Name des Dataflows	typ	Erwarteter Wert	Erforderlich?
Sprache-akzeptieren	Zeichenfolge	Der Sprachencode (z. B. en-US). Der Standard ist en-US.	nein

Parameter

Name des Dataflows	typ	Erwarteter Wert	Erforderlich?
Regelsatz	Zeichenfolge	Der Name, die ID des Regelsatzes oder eine Liste von Regelsatz-IDs oder Namen, die durch ein Komma oder ein Semikolon getrennt sind (z. B. „Lösungsüberprüfung“).	nein
includeMessageFormats	Boolesch	Wenn dies auf `true` eingestellt ist, wird die Liste mit möglichen Message-Variationen in die Ergebnisse der Sprachanfragen aufgenommen, sofern verfügbar. Diese Liste ist für Übersetzungen in mehrere Sprachen hilfreich. Wenn dies nicht erforderlich ist, geben Sie diesen Parameter nicht an oder geben Sie `false` als Wert an, da dieser Parameter die Größe der Antwort erhöht und die Verarbeitungszeit erhöhen kann.	nein

Erwartete Antworten

HTTP-Statuscode	Szenario	Ergebnis
200	Mindestens ein Ergebnis wurde gefunden	Sie finden dazu ein Beispiel später in diesem Artikel. Mindestens ein Ergebnis kann zurückgegeben werden.
204	Es wurden keine Ergebnisse gefunden	Keine Ergebnisse in Antworttext.
401	Fehler bei der Authentifizierung	Keine Ergebnisse in Antworttext.

Erwarteter Antworttext

In der folgenden Tabelle wird die Struktur der Antwort für jede Anfrage (nur HTTP-200-Antwort) dargestellt.

Eigenschaft	Typ	Erwarteter Wert	Erforderlich?
Code	Zeichenfolge	Der Bezeichner der Regel, manchmal als Regel-ID bezeichnet.	Ja
summary	Zeichenfolge	Eine Zusammenfassung der Regel.	Ja
Description	Zeichenfolge	Eine ausführlichere Beschreibung der Regel.	Ja
guidanceUrl	URI	Die URL, unter der die veröffentlichten Anweisungen zu finden sind. Es gibt unter Umständen Fälle, in denen es keinen dedizierten unterstützenden Anweisungsartikel gibt.	Ja
einschließen	boolesch	Signalisiert dem Service, dass die Regel in der Analyse berücksichtigt werden soll. Dieser Wert ist `true` für diese API.	Nein
messageTemplates	Array	Dieser Eigenschaftswert wird nur berücksichtigt, wenn `includeMessageFormats` `true` lautet.	Nein
messageTemplates.ruleId	Zeichenfolge	Gibt denselben ID-Wert wie die `code`-Eigenschaft zurück.	Ja
messageTemplates.messageTemplateId	Zeichenfolge	Ein Bezeichner, der im Static Analysis Results Interchange Format (SARIF)-Bericht verwendet wird, um eine Problem-Message-Variation für die Regel zu signalisieren.	Ja
messageTemplates.messageTemplate	Zeichenfolge	Der Text der Message-Variation für das Problemszenario, für das die Regel Berichte erstellt. Dieser Text ist eine Formatzeichenfolge, die unter Umständen Token enthält, in denen Argumente, die im SARIF-Bericht enthalten sind, verwendet werden können, um eine ausführliche Nachricht zu erstellen.	Ja

Beispiel: Regeln für einen Regelsatz in einer anderen Sprache abrufen

In diesem Beispiel werden Daten für alle Regeln im Lösungsprüfungs-Regelsatz in der französischen Sprache zurückgegeben. Falls die gewünschte Sprache Englisch ist, entfernen Sie einfach die Kopfzeile „Sprache-akzeptieren”.

Anfrage

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

Antwort

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": ""
        }
    },
...
]

Beispiel: alle abrufen

In diesem Beispiel werden Daten für alle verfügbaren Regeln zurückgegeben.

Anfrage

GET [Geographical URI]/api/rule?api-version=2.0
Accept: application/json
Content-Type: application/json; charset=utf-8

Antwort

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": ""
        }
    },
...
]

Beispiel: für einen Regelsatz mit Message-Formaten abrufen

Anfrage

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

Antwort

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 &lt;T&gt; 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."
            }
        ]
    },
...
]

Siehe auch

Verwenden Sie die Power Apps Checker-Web-API
Abrufen der Liste der Regelsätze
Hochladen einer Datei
Analyse aufrufen
Überprüfen des Analysestatus

Freigeben über

Abrufen der Regelliste

Kopfzeile

Parameter

Erwartete Antworten

Erwarteter Antworttext

Beispiel: Regeln für einen Regelsatz in einer anderen Sprache abrufen

Beispiel: alle abrufen

Beispiel: für einen Regelsatz mit Message-Formaten abrufen

Siehe auch

Feedback

Zusätzliche Ressourcen