Ανάγνωση στα Αγγλικά

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


Ανάπτυξη με τα REST API για τον Power BI Report Server

Ο Power BI Report Server υποστηρίζει API διαβίβασης κατάστασης αναπαράστασης (REST). Τα REST API είναι τελικά σημεία υπηρεσίας που υποστηρίζουν ένα σύνολο λειτουργιών (μεθόδων) HTTP, οι οποίες παρέχουν πρόσβαση δημιουργίας, ανάκτησης, ενημέρωσης ή διαγραφής για πόρους σε έναν διακομιστή αναφορών.

Το REST API παρέχει πρόσβαση μέσω προγραμματισμού στα αντικείμενα σε έναν κατάλογο του Power BI Report Server. Παραδείγματα αντικειμένων είναι οι φάκελοι, οι αναφορές, τα KPI, οι προελεύσεις δεδομένων, τα σύνολα δεδομένων, τα σχέδια ανανέωσης, οι συνδρομές και πολλά άλλα. Χρησιμοποιώντας το REST API, μπορείτε, για παράδειγμα, να περιηγηθείτε στην ιεραρχία φακέλων, να ανακαλύψετε τα περιεχόμενα ενός φακέλου ή να κάνετε λήψη ενός ορισμού αναφοράς. Μπορείτε επίσης να δημιουργήσετε, να ενημερώσετε και να διαγράψετε αντικείμενα. Παραδείγματα εργασίας με αντικείμενα είναι η αποστολή μιας αναφοράς, η εκτέλεση ενός σχεδίου ανανέωσης, η διαγραφή ενός φακέλου και ούτω καθεξής.

Σημείωση

Εάν ενδιαφέρεστε να προβάλετε ή να διαγράψετε προσωπικά δεδομένα, ανατρέξτε στις οδηγίες της Microsoft στην τοποθεσία Αιτήσεις υποκειμένων δεδομένων των Windows για τον ΓΚΠΔ . Εάν αναζητάτε γενικές πληροφορίες σχετικά με τον ΓΚΠΔ, ανατρέξτε στην ενότητα ΓΚΠΔ της πύλης αξιοπιστίας υπηρεσίας.

Στοιχεία μιας αίτησης/απόκρισης API REST

Ένα ζεύγος αίτησης/απόκρισης REST API μπορεί να διαχωριστεί σε πέντε στοιχεία:

  • Το URI αίτησης, το οποίο αποτελείται από τα εξής: {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}. Παρόλο που το URI αίτησης περιλαμβάνεται στην κεφαλίδα του μηνύματος αίτησης, το καλούμε ξεχωριστά εδώ, επειδή οι περισσότερες γλώσσες ή πλαίσια απαιτούν να τα διαβιβάσετε ξεχωριστά από το μήνυμα αίτησης.

    • Σχήμα URI: Υποδεικνύει το πρωτόκολλο που χρησιμοποιείται για τη μετάδοση της αίτησης. Για παράδειγμα, http ή https.
    • Κεντρικός υπολογιστής URI: Καθορίζει το όνομα τομέα ή τη διεύθυνση IP του διακομιστή όπου φιλοξενείται το τελικό σημείο της υπηρεσίας REST, όπως myserver.contoso.com.
    • Διαδρομή πόρου: Καθορίζει τον πόρο ή τη συλλογή πόρων, που μπορεί να περιλαμβάνει πολλά τμήματα που χρησιμοποιούνται από την υπηρεσία για τον προσδιορισμό της επιλογής αυτών των πόρων. Για παράδειγμα, CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties το μπορεί να χρησιμοποιηθεί για τη λήψη των καθορισμένων ιδιοτήτων για το CatalogItem.
    • Συμβολοσειρά ερωτήματος (προαιρετικό): Παρέχει πρόσθετες απλές παραμέτρους, όπως η έκδοση API ή τα κριτήρια επιλογής πόρου.
  • Πεδία κεφαλίδας μηνύματος αίτησης HTTP:

    • Μια απαιτούμενη μέθοδος HTTP (γνωστή και ως λειτουργία ή ρήμα), η οποία υποδεικνύει στην υπηρεσία τον τύπο της λειτουργίας που ζητάτε. Τα API REST των υπηρεσιών αναφοράς υποστηρίζουν τις μεθόδους DELETE, GET, HEAD, PUT, POST και PATCH.
    • Προαιρετικά πρόσθετα πεδία κεφαλίδας, όπως απαιτείται από το καθορισμένο URI και τη μέθοδο HTTP.
  • Προαιρετικά πεδία σώματος μηνύματος αίτησης HTTP για την υποστήριξη του URI και της λειτουργίας HTTP. Για παράδειγμα, οι λειτουργίες POST περιέχουν αντικείμενα με κωδικοποίηση MIME που μεταβιβάζονται ως σύνθετες παράμετροι. Για λειτουργίες POST ή PUT, ο τύπος κωδικοποίησης MIME για το σώμα πρέπει επίσης να καθορίζεται στην Content-type κεφαλίδα αίτησης. Ορισμένες υπηρεσίες απαιτούν να χρησιμοποιήσετε έναν συγκεκριμένο τύπο MIME, όπως application/json.

  • Πεδία κεφαλίδας μηνύματος απόκρισης HTTP:

    • Ένας κωδικός κατάστασης HTTP, που κυμαίνεται από κωδικούς επιτυχίας 2xx έως κωδικούς σφαλμάτων 4xx ή 5xx. Εναλλακτικά, μπορεί να επιστραφεί ένας κωδικός κατάστασης που καθορίζεται από την υπηρεσία, όπως υποδεικνύεται στην τεκμηρίωση του API.
    • Προαιρετικά πρόσθετα πεδία κεφαλίδας, όπως απαιτείται για την υποστήριξη της απόκρισης της αίτησης, όπως μια Content-type κεφαλίδα απόκρισης.
  • Προαιρετικά πεδία σώματος μηνύματος απόκρισης:

    • Τα αντικείμενα απόκρισης με κωδικοποίηση MIME επιστρέφονται στο σώμα της απόκρισης HTTP, όπως μια απόκριση από μια μέθοδο GET που επιστρέφει δεδομένα. Συνήθως, αυτά τα αντικείμενα επιστρέφονται σε δομημένη μορφή όπως JSON ή XML, όπως υποδεικνύεται από την Content-type κεφαλίδα απόκρισης.

Τεκμηρίωση API

Ένα σύγχρονο REST API απαιτεί σύγχρονη τεκμηρίωση API. Το REST API βασίζεται στην προδιαγραφή OpenAPI (δηλ. η προδιαγραφή swagger) και η τεκμηρίωση είναι διαθέσιμη στο Microsoft Learn.

Δοκιμές κλήσεων API

Ένα εργαλείο για τον έλεγχο των μηνυμάτων αίτησης/απόκρισης HTTP είναι το Fiddler. Το Fiddler είναι ένας δωρεάν διακομιστής μεσολάβησης εντοπισμού σφαλμάτων web που μπορεί να αναχαιτίσει τις αιτήσεις REST, καθιστώντας εύκολη τη διάγνωση των μηνυμάτων αίτησης/απόκρισης HTTP.

Εξετάστε τα διαθέσιμα API στο Microsoft Learn.

Τα δείγματα είναι διαθέσιμα στο GitHub. Το δείγμα περιλαμβάνει μια εφαρμογή HTML5 που έχει δημιουργηθεί σε TypeScript, React και webpack, καθώς και ένα παράδειγμα PowerShell.

Περισσότερες ερωτήσεις; Δοκιμάστε να ρωτήσετε τον Κοινότητα Power BI