Μέθοδοι σύνδεσης για δημιουργία σελίδων

Χρησιμοποιήστε τις μεθόδους σύνδεσης του dataApi αντικειμένου για να εργαστείτε με δεδομένα που εκτίθενται από μια σύνδεση Power Platform που είναι συνδεδεμένη στη σελίδα.

Σημείωμα

Οι μέθοδοι σύνδεσης είναι προαιρετικές στην κοινόχρηστη dataApi σύμβαση. Ορισμένοι κεντρικοί υπολογιστές δεν τους υλοποιούν, επομένως ελέγξτε ότι υπάρχει μια μέθοδος πριν την κλήση της. Μια παρούσα μέθοδος δεν σημαίνει ότι η σελίδα έχει μια σύνδεση συνδεδεμένη σε αυτήν ή ότι η σύνδεση, το σύνολο δεδομένων, ο πίνακας ή η λειτουργία ρυθμίζεται, εξουσιοδοτείται ή επιτρέπεται όπως αναμένεται.

Σε αντίθεση με τις μεθόδους ενέργειας και συναρτήσεων, οι μέθοδοι σύνδεσης απορρίπτουν την υπόσχεση που επιστρέφεται όταν αποτυγχάνει μια κλήση, για παράδειγμα, όταν η αναφορά σύνδεσης δεν μπορεί να επιλυθεί, η σύνδεση δεν είναι εξουσιοδοτημένη και ο χρήστης δεν συμπληρώνει τη γραμμή εντολών συγκατάθεσης ή η σύνδεση επιστρέφει μια κατάσταση σφάλματος. executeConnectorOperation Το επιλύεται με ok: false το για τις περισσότερες καταστάσεις σφάλματος, αλλά εξακολουθεί να απορρίπτει για μια λειτουργία που λείπει, μια μη εξουσιοδοτημένη σύνδεση (403) χωρίς ολοκληρωμένη συγκατάθεση ή αποτυχία μεταφοράς. Αναδίπλωση κλήσεων σύνδεσης στο try/catch.

Μέθοδος	Περιγραφή
createConnectorRow	Δημιουργεί μια νέα γραμμή στον καθορισμένο πίνακα σύνδεσης.
deleteConnectorRow	Διαγράφει μια γραμμή από τον καθορισμένο πίνακα σύνδεσης.
executeConnectorOperation	Καλεί μια επώνυμη λειτουργία που εκτίθεται από μια σύνδεση REST (με κλειδί λειτουργίας), όπως Χρήστες του Office 365.
getConnectorSwagger	Ανακτά τον ορισμό Swagger (OpenAPI) για τη σύνδεση.
getConnectorTableSchema	Ανακτά το σχήμα ενός πίνακα (που ονομάζεται επίσης οντότητα ή λίστα) που εμφανίζεται από τη σύνδεση.
listConnectorDatasets	Παραθέτει τα σύνολα δεδομένων που είναι διαθέσιμα για τη σύνδεση.
listConnectorOperations	Παραθέτει τις λειτουργίες που εκτίθενται από μια σύνδεση REST (με κλειδί λειτουργίας).
listConnectorTables	Παραθέτει τους πίνακες που είναι διαθέσιμοι στο καθορισμένο σύνολο δεδομένων σύνδεσης.
queryConnectorTable	Υποβάλλει ερωτήματα σε έναν πίνακα που εμφανίζεται από τη σύνδεση με τις καθορισμένες επιλογές.
retrieveConnectorRow	Ανακτά μια μοναδική γραμμή από τον καθορισμένο πίνακα σύνδεσης.
updateConnectorRow	Ενημερώνει μια υπάρχουσα γραμμή στον καθορισμένο πίνακα σύνδεσης.

queryConnectorTable μέθοδος

Υποβάλλει ερώτημα σε έναν πίνακα που εμφανίζεται από τη σύνδεση, χρησιμοποιώντας τις καθορισμένες επιλογές.

Παράμετροι

Ορίστε τιμές για αυτές τις απαιτούμενες παραμέτρους.

Πλήρες όνομα	Τύπος	Περιγραφή
connectorLogicalName	string	Το λογικό όνομα της αναφοράς σύνδεσης που συνδέεται στη σελίδα (για παράδειγμα, sp_shared_sharepointonline).
dataset	string	Το σύνολο δεδομένων που περιέχει τον πίνακα, όπως μια διεύθυνση URL SharePoint τοποθεσίας.
tableName	string	Το εσωτερικό όνομα του πίνακα, από την ιδιότητα που επιστρέφεται από listConnectorTablesτο name . Μην χρησιμοποιείτε το εμφανιζόμενο όνομα.
options	QueryConnectorTableOptions	Επιλογές για την υποβολή ερωτημάτων στον πίνακα.

QueryConnectorTableOptions

Πλήρες όνομα	Τύπος	Περιγραφή
select	string[]	(Συνιστάται) Ο πίνακας ονομάτων στηλών προς ανάκτηση.
filter	string	(Προαιρετικό) Η παράσταση φίλτρου υποστηρίζεται από τη σύνδεση.
orderBy	string	(Προαιρετικό) Παράσταση order-by που υποστηρίζεται από τη σύνδεση.
top	number	(Προαιρετικό) Μέγιστος αριθμός γραμμών προς επιστροφή.

Επιστροφές

Μια υπόσχεση που περιέχει το αποτέλεσμα της επιχείρησης. Όταν η λειτουργία ολοκληρωθεί με επιτυχία, η υπόσχεση επιστρέφει ένα αντικείμενο που περιέχει έναν πίνακα δεδομένων με τα αποτελέσματα με αυτές τις ιδιότητες:

Πλήρες όνομα	Τύπος	Περιγραφή
rows	Object[]	Πίνακας δεδομένων γραμμών.
hasMoreRows	boolean	Υποδεικνύει εάν υπάρχουν περισσότερες διαθέσιμες γραμμές.

queryConnectorTable Η επιστρέφει μία μόνο σελίδα αποτελεσμάτων. Δεν επιστρέφει μια συνάρτηση συνέχειας και προς το παρόν δεν υποστηρίζεται τρόπος ανάκτησης της επόμενης σελίδας. Όταν hasMoreRows είναι true, αντιστοιχίστηκαν περισσότερες γραμμές από όσες επιστράφηκαν. Περιορίστε το ερώτημα με filterή πείτε στον χρήστη ότι τα αποτελέσματα είναι ελλιπή.

παράδειγμα queryConnectorTable

if (!dataApi.listConnectorTables || !dataApi.queryConnectorTable) {
  throw new Error("Connector methods aren't available on this page.");
}

const tables = await dataApi.listConnectorTables(
  "sp_shared_sharepointonline",
  "https://contoso.sharepoint.com/sites/Marketing"
);
const documentsTable = tables.find((table) => table.displayName === "Documents");
if (!documentsTable) {
  throw new Error("The Documents table wasn't found in this dataset.");
}
const documentsTableName = documentsTable.name;

const result = await dataApi.queryConnectorTable(
  "sp_shared_sharepointonline",
  "https://contoso.sharepoint.com/sites/Marketing",
  documentsTableName,
  {
    select: ["Title", "Modified"],
    top: 50,
  }
);

Τα παρακάτω παραδείγματα προϋποθέτουν ότι documentsTableName ισχύουν οι πίνακες name από listConnectorTablesτον πίνακα , όπως φαίνεται παραπάνω.

listConnectorTables μέθοδος

Παραθέτει τους πίνακες (λίστες ή οντότητες) που είναι διαθέσιμοι στο καθορισμένο σύνολο δεδομένων σύνδεσης.

Παράμετροι

Ορίστε τιμές για αυτές τις απαιτούμενες παραμέτρους.

Πλήρες όνομα	Τύπος	Περιγραφή
connectorLogicalName	string	Το λογικό όνομα της αναφοράς σύνδεσης που συνδέεται στη σελίδα.
dataset	string	Το σύνολο δεδομένων για το οποίο θα παρατίθενται πίνακες.

Επιστροφές

Μια υπόσχεση που περιέχει μια σειρά πληροφοριών πίνακα. Κάθε καταχώρηση έχει τις εξής ιδιότητες:

Πλήρες όνομα	Τύπος	Περιγραφή
name	string	Το εσωτερικό όνομα του πίνακα.
displayName	string	Το εμφανιζόμενο όνομα του πίνακα.

παράδειγμα listConnectorTables

const tables = await dataApi.listConnectorTables?.(
  "sp_shared_sharepointonline",
  "https://contoso.sharepoint.com/sites/Marketing"
);

listConnectorDatasets μέθοδος

Παραθέτει τα σύνολα δεδομένων που είναι διαθέσιμα για τη σύνδεση, όπως τα SharePoint τοποθεσίες στις οποίες μπορεί να έχει πρόσβαση μια σύνδεση.

Παράμετροι

Ορίστε μια τιμή για αυτή την απαιτούμενη παράμετρο.

Πλήρες όνομα	Τύπος	Περιγραφή
connectorLogicalName	string	Το λογικό όνομα της αναφοράς σύνδεσης που συνδέεται στη σελίδα.

Επιστροφές

Μια υπόσχεση που περιέχει μια σειρά πληροφοριών συνόλου δεδομένων. Κάθε καταχώρηση έχει τις εξής ιδιότητες:

Πλήρες όνομα	Τύπος	Περιγραφή
name	string	Το εσωτερικό όνομα ή αναγνωριστικό του συνόλου δεδομένων.
displayName	string	Το εμφανιζόμενο όνομα του συνόλου δεδομένων.

παράδειγμα listConnectorDatasets

const datasets = await dataApi.listConnectorDatasets?.("sp_shared_sharepointonline");

listConnectorOperations μέθοδος

Παραθέτει τις λειτουργίες που ορίζονται στον ορισμό Swagger της σύνδεσης, εξαιρώντας τις λειτουργίες που επισημαίνονται εσωτερικά, ταξινομημένες κατά εμφανιζόμενο όνομα. Αυτή η μέθοδος είναι πιο χρήσιμη για συνδέσεις REST (με κλειδί λειτουργίας), όπως Χρήστες του Office 365. Για τις συνδέσεις σε μορφή πίνακα, χρησιμοποιήστε τις μεθόδους ερωτήματος και γραμμής αντί για τις λειτουργίες που παραθέτει αυτή η μέθοδος.

Παράμετροι

Ορίστε μια τιμή για αυτή την απαιτούμενη παράμετρο.

Πλήρες όνομα	Τύπος	Περιγραφή
connectorLogicalName	string	Το λογικό όνομα της αναφοράς σύνδεσης που συνδέεται στη σελίδα.

Επιστροφές

Μια υπόσχεση που περιέχει μια σειρά πληροφοριών για την επιχείρηση. Κάθε καταχώρηση έχει τις εξής ιδιότητες:

Πλήρες όνομα	Τύπος	Περιγραφή
name	string	Το αναγνωριστικό λειτουργίας, όπως ορίζεται στον ορισμό Swagger της σύνδεσης. Μεταβιβάστε αυτήν την τιμή στη executeConnectorOperation.
displayName	string	Το αναγνώσιμο όνομα λειτουργίας για εμφάνιση, όπως η σύνοψη Swagger. Επιστρέφει στην name εάν δεν έχει οριστεί σύνοψη.

παράδειγμα listConnectorOperations

const operations = await dataApi.listConnectorOperations?.("sp_shared_sharepointonline");

getConnectorSwagger μέθοδος

Ανακτά τον ορισμό Swagger (OpenAPI) για τη σύνδεση, το οποίο περιγράφει τις λειτουργίες που εκθέτει. Το έγγραφο που επιστράφηκε περιγράφει συνολικά τη σύνδεση. Δεν περιλαμβάνει σχήματα στηλών ανά πίνακα για συνδέσεις σε μορφή πίνακα. Χρησιμοποιήστε getConnectorTableSchema το για αυτές τις πληροφορίες.

Παράμετροι

Ορίστε μια τιμή για αυτή την απαιτούμενη παράμετρο.

Πλήρες όνομα	Τύπος	Περιγραφή
connectorApiId	string	Το αναγνωριστικό API σύνδεσης, όπως /providers/Microsoft.PowerApps/apis/shared_sharepointonline. Αυτό το αναγνωριστικό είναι διαφορετικό από το λογικό όνομα αναφοράς σύνδεσης (connectorLogicalName) που χρησιμοποιείται από τις περισσότερες άλλες μεθόδους σύνδεσης.

Επιστροφές

Μια υπόσχεση που περιέχει τον ορισμό swagger της σύνδεσης ως αντικείμενο.

παράδειγμα getConnectorSwagger

if (!dataApi.getConnectorSwagger) {
  throw new Error("getConnectorSwagger isn't available on this page.");
}

const swagger = await dataApi.getConnectorSwagger(
  "/providers/Microsoft.PowerApps/apis/shared_sharepointonline"
);

getConnectorTableSchema μέθοδος

Ανακτά το σχήμα (ορισμοί στηλών) για έναν πίνακα που εμφανίζεται από τη σύνδεση. Η σύνδεση ορίζει το σχήμα που επιστρέφει και διαφέρει ανάλογα με τη σύνδεση. Μην υποθέτετε ότι περιλαμβάνει κάθε δυναμική στήλη που μπορεί να περιέχει ένας πίνακας.

Παράμετροι

Ορίστε τιμές για αυτές τις απαιτούμενες παραμέτρους.

Πλήρες όνομα	Τύπος	Περιγραφή
connectorLogicalName	string	Το λογικό όνομα της αναφοράς σύνδεσης που συνδέεται στη σελίδα.
dataset	string	Το σύνολο δεδομένων που περιέχει τον πίνακα.
tableName	string	Το εσωτερικό όνομα του πίνακα, από την ιδιότητα που επιστρέφεται από listConnectorTablesτο name . Μην χρησιμοποιείτε το εμφανιζόμενο όνομα.

Επιστροφές

Μια υπόσχεση που περιέχει το σχήμα του πίνακα ως αντικείμενο.

παράδειγμα getConnectorTableSchema

if (!dataApi.getConnectorTableSchema) {
  throw new Error("getConnectorTableSchema isn't available on this page.");
}

const schema = await dataApi.getConnectorTableSchema(
  "sp_shared_sharepointonline",
  "https://contoso.sharepoint.com/sites/Marketing",
  documentsTableName // from listConnectorTables
);

retrieveConnectorRow μέθοδος

Ανακτά μια μοναδική γραμμή από τον καθορισμένο πίνακα σύνδεσης.

Παράμετροι

Ορίστε τιμές για αυτές τις απαιτούμενες παραμέτρους.

Πλήρες όνομα	Τύπος	Περιγραφή
connectorLogicalName	string	Το λογικό όνομα της αναφοράς σύνδεσης που συνδέεται στη σελίδα.
dataset	string	Το σύνολο δεδομένων που περιέχει τον πίνακα.
tableName	string	Το εσωτερικό όνομα του πίνακα, από την ιδιότητα που επιστρέφεται από listConnectorTablesτο name . Μην χρησιμοποιείτε το εμφανιζόμενο όνομα.
id	string	Το αναγνωριστικό της γραμμής προς ανάκτηση.
options	RetrieveConnectorRowOptions	(Προαιρετικό) Επιλογές για την ανάκτηση της γραμμής.

RetrieveConnectorRowOptions

Πλήρες όνομα	Τύπος	Περιγραφή
select	string[]	(Συνιστάται) Ο πίνακας ονομάτων στηλών προς ανάκτηση. Εάν παραλειφθεί, δεν $select αποστέλλεται προβολή — η σύνδεση καθορίζει ποιες στήλες θα επιστραφούν και δεν εγγυάται την επιστροφή κάθε στήλης στη γραμμή.

Επιστροφές

Μια υπόσχεση που περιέχει τα δεδομένα των γραμμών.

παράδειγμα retrieveConnectorRow

if (!dataApi.retrieveConnectorRow) {
  throw new Error("retrieveConnectorRow isn't available on this page.");
}

const row = await dataApi.retrieveConnectorRow(
  "sp_shared_sharepointonline",
  "https://contoso.sharepoint.com/sites/Marketing",
  documentsTableName, // from listConnectorTables
  "1"
);

createConnectorRow μέθοδος

Δημιουργεί μια νέα γραμμή στον καθορισμένο πίνακα σύνδεσης.

Παράμετροι

Ορίστε τιμές για αυτές τις απαιτούμενες παραμέτρους.

Πλήρες όνομα	Τύπος	Περιγραφή
connectorLogicalName	string	Το λογικό όνομα της αναφοράς σύνδεσης που συνδέεται στη σελίδα.
dataset	string	Το σύνολο δεδομένων που περιέχει τον πίνακα.
tableName	string	Το εσωτερικό όνομα του πίνακα, από την ιδιότητα που επιστρέφεται από listConnectorTablesτο name . Μην χρησιμοποιείτε το εμφανιζόμενο όνομα.
row	object	Τα δεδομένα γραμμής που θα δημιουργηθούν.

Επιστροφές

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

παράδειγμα createConnectorRow

if (!dataApi.createConnectorRow) {
  throw new Error("createConnectorRow isn't available on this page.");
}

const newRow = await dataApi.createConnectorRow(
  "sp_shared_sharepointonline",
  "https://contoso.sharepoint.com/sites/Marketing",
  documentsTableName, // from listConnectorTables
  { Title: "New document" }
);

updateConnectorRow μέθοδος

Ενημερώνει μια υπάρχουσα γραμμή στον καθορισμένο πίνακα σύνδεσης.

Παράμετροι

Ορίστε τιμές για αυτές τις απαιτούμενες παραμέτρους.

Πλήρες όνομα	Τύπος	Περιγραφή
connectorLogicalName	string	Το λογικό όνομα της αναφοράς σύνδεσης που συνδέεται στη σελίδα.
dataset	string	Το σύνολο δεδομένων που περιέχει τον πίνακα.
tableName	string	Το εσωτερικό όνομα του πίνακα, από την ιδιότητα που επιστρέφεται από listConnectorTablesτο name . Μην χρησιμοποιείτε το εμφανιζόμενο όνομα.
id	string	Το αναγνωριστικό της γραμμής προς ενημέρωση.
row	object	Τα δεδομένα γραμμής προς ενημέρωση.

Επιστροφές

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

παράδειγμα updateConnectorRow

if (!dataApi.updateConnectorRow) {
  throw new Error("updateConnectorRow isn't available on this page.");
}

const updatedRow = await dataApi.updateConnectorRow(
  "sp_shared_sharepointonline",
  "https://contoso.sharepoint.com/sites/Marketing",
  documentsTableName, // from listConnectorTables
  "1",
  { Title: "Updated title" }
);

deleteConnectorRow μέθοδος

Διαγράφει μια γραμμή από τον καθορισμένο πίνακα σύνδεσης.

Παράμετροι

Ορίστε τιμές για αυτές τις απαιτούμενες παραμέτρους.

Πλήρες όνομα	Τύπος	Περιγραφή
connectorLogicalName	string	Το λογικό όνομα της αναφοράς σύνδεσης που συνδέεται στη σελίδα.
dataset	string	Το σύνολο δεδομένων που περιέχει τον πίνακα.
tableName	string	Το εσωτερικό όνομα του πίνακα, από την ιδιότητα που επιστρέφεται από listConnectorTablesτο name . Μην χρησιμοποιείτε το εμφανιζόμενο όνομα.
id	string	Το αναγνωριστικό της γραμμής που θα διαγραφεί.

Επιστροφές

Μια υπόσχεση που περιέχει το αποτέλεσμα της επιχείρησης. Όταν η λειτουργία ολοκληρωθεί με επιτυχία, δεν επιστρέφει καμία τιμή.

Παράδειγμα deleteConnectorRow

if (!dataApi.deleteConnectorRow) {
  throw new Error("deleteConnectorRow isn't available on this page.");
}

await dataApi.deleteConnectorRow(
  "sp_shared_sharepointonline",
  "https://contoso.sharepoint.com/sites/Marketing",
  documentsTableName, // from listConnectorTables
  "1"
);

executeConnectorOperation μέθοδος

Καλεί μια επώνυμη λειτουργία που εκτίθεται από μια σύνδεση REST (με κλειδί λειτουργίας), όπως HTTP, αποστολή μηνύματος Teams ή Χρήστες του Office 365. Οι συνδέσεις σε μορφή πίνακα θα πρέπει να χρησιμοποιούν τις μεθόδους CRUD ερωτήματος και γραμμής.

Παράμετροι

Ορίστε τιμές για αυτές τις απαιτούμενες παραμέτρους.

Πλήρες όνομα	Τύπος	Περιγραφή
connectorLogicalName	string	Το λογικό όνομα της αναφοράς σύνδεσης που συνδέεται στη σελίδα.
operationName	string	Το αναγνωριστικό λειτουργίας, όπως ορίζεται στον ορισμό Swagger της σύνδεσης.
parameters	object	Οι παράμετροι που απαιτούνται από τη λειτουργία. Διαβιβάστε ένα κενό αντικείμενο ({}) εάν η λειτουργία δεν λαμβάνει παραμέτρους — αυτή η παράμετρος απαιτείται ακόμα και όταν δεν υπάρχει κάτι προς αποστολή.

Επιστροφές

Μια υπόσχεση που περιέχει το αποτέλεσμα της επιχείρησης με αυτές τις ιδιότητες. Η υπόσχεση απορρίπτεται εάν η αναφορά σύνδεσης δεν μπορεί να επιλυθεί, δεν είναι δυνατή η ανάκτηση του ορισμού Swagger της σύνδεσης, δεν βρίσκεται η λειτουργία σε αυτή, δεν είναι δυνατή η αποστολή της κλήσης ή η σύνδεση δεν είναι εξουσιοδοτημένη (HTTP 403) και ο χρήστης δεν συμπληρώνει τη γραμμή συγκατάθεσης σύνδεσης.

Πλήρες όνομα	Τύπος	Περιγραφή
ok	boolean	true όταν η υποκείμενη κατάσταση HTTP είναι μικρότερη από 400. Αυτή η κατάσταση περιλαμβάνει τις καταστάσεις ανακατεύθυνσης (3xx), επομένως μην αντιμετωπίζετε ok μόνοι σας ως απόδειξη ότι η λειτουργία επέστρεψε δεδομένα - επίσης ελέγξτε status ή επιθεωρήστε body.
status	number	Ο μη επεξεργασμένος κωδικός κατάστασης HTTP που επιστρέφεται από τη σύνδεση.
body	unknown	Το σώμα απόκρισης JSON που έχει αναλυθεί ή η μη επεξεργασμένη συμβολοσειρά εάν το σώμα δεν είναι JSON.

παράδειγμα executeConnectorOperation

Το παρακάτω παράδειγμα προϋποθέτει μια λειτουργία με την ονομασία CopyFile που αποδέχεται sourceUrl και destinationUrl παραμέτρους. Επαληθεύστε το αναγνωριστικό λειτουργίας και τις παραμέτρους του σύμφωνα με τον ορισμό Swagger της σύνδεσης (για παράδειγμα, με ή getConnectorSwagger) πριν από τη χρήση του, καθώς οι διαθέσιμες λειτουργίες και οι παράμετροί τους διαφέρουν ανάλογα με listConnectorOperations τη σύνδεση.

if (!dataApi.executeConnectorOperation) {
  throw new Error("executeConnectorOperation isn't available on this page.");
}

try {
  const result = await dataApi.executeConnectorOperation(
    "sp_shared_sharepointonline",
    "CopyFile",
    { sourceUrl: "/sites/Marketing/Shared Documents/file.docx", destinationUrl: "/sites/Sales/Shared Documents/file.docx" }
  );

  if (result.ok) {
    console.log(result.body);
  }
  else {
    console.log(result.status);
  }
}
catch (error) {
  console.log(error);
}