שיטות מחבר עבור עמודים generative

השתמש בשיטות המחבר של האובייקט 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 השם הפנימי של הטבלה, מהמאפיין שהוחזר name על-ידי listConnectorTables. אל תשתמש בשם התצוגה.
options אפשרויות QueryConnectorTable אפשרויות עבור ביצוע שאילתה בטבלה.

אפשרויות QueryConnectorTable

שם סוג תיאור
select string[] (מומלץ) מערך של שמות עמודות לאחזור.
filter string (אופציונלי) ביטוי מסנן הנתמך על-ידי המחבר.
orderBy string (אופציונלי) ביטוי Order-by הנתמך על-ידי המחבר.
top number (אופציונלי) מספר השורות המרבי להחזרה.

החזרות

הבטחה המכילה את תוצאת הפעולה. כאשר הפעולה מצליחה, ההבטחה מחזירה אובייקט המכיל טבלת נתונים עם התוצאות הכוללות מאפיינים אלה:

שם סוג תיאור
rows Object[] מערך של נתוני שורה.
hasMoreRows boolean מציין אם יש שורות זמינות נוספות.

queryConnectorTable מחזירה עמוד תוצאות בודד. הוא אינו מחזיר פונקציית המשך, ולעתים אין דרך נתמכת להביא את הדף הבא. כאשר hasMoreRows הוא true, שורות רבות יותר תואמות מהשורות שהוחזרו. צמצם את השאילתה filterב- או הודע למשתמש שהתוצאות שלמות.

דוגמה לשאילתהConnectorTable

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 על ההנחה שהטבלה היא מתוך namelistConnectorTables, כפי שמוצג לעיל.

listConnectorTables שיטת

פירוט הטבלאות (רשימות או ישויות) הזמינות בערכת הנתונים של המחבר שצוינה.

פרמטרים

הגדר ערכים עבור פרמטרים נדרשים אלה.

שם סוג תיאור
connectorLogicalName string השם הלוגי של ההפניה לחיבור המאוגדת לדף.
dataset string ערכת הנתונים שעבורה יש להוסיף רשימה של טבלאות.

החזרות

הבטחה המכילה מערך של מידע טבלה. לכל ערך יש מאפיינים אלה:

שם סוג תיאור
name string השם הפנימי של הטבלה.
displayName string שם התצוגה של הטבלה.

listConnectorTables example

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 example

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 השם הפנימי של הטבלה, מהמאפיין שהוחזר name על-ידי listConnectorTables. אל תשתמש בשם התצוגה.

החזרות

הבטחה המכילה את סכימת הטבלה אובייקטים.

דוגמה ל- 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 השם הפנימי של הטבלה, מהמאפיין שהוחזר name על-ידי listConnectorTables. אל תשתמש בשם התצוגה.
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 השם הפנימי של הטבלה, מהמאפיין שהוחזר name על-ידי listConnectorTables. אל תשתמש בשם התצוגה.
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 השם הפנימי של הטבלה, מהמאפיין שהוחזר name על-ידי listConnectorTables. אל תשתמש בשם התצוגה.
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 השם הפנימי של הטבלה, מהמאפיין שהוחזר name על-ידי listConnectorTables. אל תשתמש בשם התצוגה.
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 מקבלת ופרמטרים sourceUrldestinationUrl . אמת את מזהה הפעולה ואת הפרמטרים שלו מול הגדרת Swagger של המחבר (לדוגמה, listConnectorOperationsgetConnectorSwaggerעם או ) לפני השימוש בו, מאחר שהפעולות הזמינות והפרמטרים שלהן משתנים בהתאם למחבר.

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);
}