Ανάκτηση της λίστας κανόνων

Άρθρο
05/01/2024

Οι κανόνες ομαδοποιούνται μαζί με ένα σύνολο κανόνων. Ένας κανόνας μπορεί να είναι σε κανένα σύνολο κανόνων ή να είναι σε πολλαπλά σύνολα κανόνων. Χρησιμοποιήστε μια αίτηση GET για να λάβετε μια λίστα όλων των διαθέσιμων κανόνων, κανόνων σε ένα σύνολο κανόνων ή συνόλων κανόνων καλώντας το API [Geographical URI]/api/rule. Υπάρχουν μερικές παραλλαγές για την κλήση αυτού του API, ωστόσο, η πιο συνηθισμένη χρήση είναι η ανάκτηση της λίστας κανόνων για ένα συγκεκριμένο σύνολο κανόνων.

Σημείωμα

Αυτό το API απαιτεί διακριτικό OAuth .

Κεφαλίδες

Ονομασία	Type	Αναμενόμενη τιμή	Υποχρεωτικό;
Αποδοχή-γλώσσα	string	Ο κωδικός γλώσσας (για παράδειγμα, en-US). Η προεπιλεγμένη τιμή είναι en-US.	όχι

Παράμετροι

Ονομασία	Type	Αναμενόμενη τιμή	Υποχρεωτικό;
ruleset	string	Το όνομα ή το αναγνωριστικό του συνόλου κανόνων ή μια λίστα αναγνωριστικών συνόλων κανόνων ή ονομάτων, που διαχωρίζονται με κόμμα ή ελληνικό ερωτηματικό (για παράδειγμα, "Ελεγκτής λύσης").	όχι
includeMessageFormats	δυαδ.	Όταν έχει οριστεί σε `true`, η λίστα πιθανών αποκλίσεων μηνυμάτων περιλαμβάνεται στα αποτελέσματα των αιτήσεων γλωσσών, εάν είναι διαθέσιμα. Αυτή η λίστα είναι χρήσιμη για μεταφράσεις σε πολλές γλώσσες. Εάν δεν είναι απαραίτητο, τότε μην παρέχετε αυτήν την παράμετρο ή παρέχετε `false` ως την τιμή, καθώς αυτή η παράμετρος αυξάνει το μέγεθος της απόκρισης και μπορεί να αυξήσει το χρόνο επεξεργασίας.	όχι

Αναμενόμενες αποκρίσεις

Κωδικός κατάστασης HTTP	Σενάριο	Result
200	Εντοπίστηκαν ένα ή περισσότερα αποτελέσματα	Δείτε το παράδειγμα στη συνέχεια αυτού του άρθρου. Είναι δυνατή η επιστροφή ενός ή περισσότερων αποτελεσμάτων.
204	Δεν βρέθηκαν αποτελέσματα	Δεν υπάρχουν αποτελέσματα στον σώμα απόκρισης.
401	Ο έλεγχος ταυτότητας απέτυχε	Δεν υπάρχουν αποτελέσματα στον σώμα απόκρισης.

Σώμα αναμενόμενης απόκρισης

Ο ακόλουθος πίνακας περιγράφει τη δομή της απόκρισης για κάθε αίτηση (μόνο για απόκριση HTTP 200).

Ιδιότητα	Τύπος	Αναμενόμενη τιμή	Υποχρεωτικό;
κωδικός	string	Το αναγνωριστικό του κανόνα, το οποίο μερικές φορές αναφέρεται ως αναγνωριστικό κανόνα (Rule ID).	Ναι
Σύνοψη	string	Μια περίληψη του κανόνα.	Ναι
description	string	Λεπτομερέστερη περιγραφή του κανόνα.	Ναι
guidanceUrl	URI	Η διεύθυνση URL στην οποία θα βρείτε δημοσιευμένη καθοδήγηση. Μπορεί να υπάρχουν ορισμένες περιπτώσεις όπου δεν υπάρχει αποκλειστικό άρθρο για την καθοδήγηση υποστήριξης.	Ναι
συμπερίληψη	boolean	Επισημαίνει στην υπηρεσία ότι ο κανόνας πρέπει να συμπεριληφθεί στην ανάλυση. Αυτή η τιμή είναι `true` για αυτό το API.	Όχι
messageTemplates	πίνακας	Αυτή η τιμή ιδιότητας περιλαμβάνεται μόνο όταν το `includeMessageFormats` είναι `true`.	Όχι
messageTemplates.ruleId	string	Αποδίδει την ίδια τιμή αναγνωριστικού με την ιδιότητα `code`.	Ναι
messageTemplates.messageTemplateId	string	Ένα αναγνωριστικό που χρησιμοποιείται σε αναφορά Static Analysis Results Interchange Format (SARIF) για να σηματοδοτήσει μια έκδοση παραλλαγής μηνύματος για τον κανόνα.	Ναι
messageTemplates.messageTemplate	string	Το κείμενο της παραλλαγής μηνύματος για το σενάριο έκδοσης που αναφέρει ο κανόνας. Αυτό το κείμενο είναι για μια συμβολοσειρά μορφοποίησης που μπορεί να περιέχει διακριτικά, στα οποία τα ορίσματα που περιλαμβάνονται στην αναφορά SARIF μπορούν να χρησιμοποιηθούν για τη δημιουργία ενός λεπτομερούς μηνύματος.	Ναι

Παράδειγμα: ανάκτηση κανόνων για ένα σύνολο κανόνων σε άλλη γλώσσα

Αυτό το παράδειγμα επιστρέφει δεδομένα για όλους τους κανόνες στο σύνολο κανόνων του Ελεγκτή λύσεων στα γαλλικά. Εάν η επιθυμητή γλώσσα είναι τα Γαλλικά, καταργήστε απλώς την κεφαλίδα Αποδοχή γλώσσας.

Αίτηση

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

Παράδειγμα: ανάκτηση για ένα σύνολο κανόνων με μορφές μηνυμάτων

Αίτηση

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

Δείτε επίσης

Χρησιμοποιήστε το Power Apps checker web API
Ανάκτηση της λίστας συνόλων κανόνων
Αποστολή αρχείου
Κλήση ανάλυσης
Έλεγχος κατάστασης ανάλυσης

Κοινή χρήση μέσω

Ανάκτηση της λίστας κανόνων

Κεφαλίδες

Παράμετροι

Αναμενόμενες αποκρίσεις

Σώμα αναμενόμενης απόκρισης

Παράδειγμα: ανάκτηση κανόνων για ένα σύνολο κανόνων σε άλλη γλώσσα

Παράδειγμα: ανάκτηση όλων

Παράδειγμα: ανάκτηση για ένα σύνολο κανόνων με μορφές μηνυμάτων

Δείτε επίσης

Σχόλια

Πρόσθετοι πόροι