Összekötőmetódusok generatív oldalakhoz

Az objektum összekötőmetódusaival dataApi az oldalhoz kötött Power Platform-összekötő által közzétett adatokkal dolgozhat.

Megjegyzés

Az összekötő metódusai nem kötelezőek a megosztott dataApi szerződésben. Egyes gazdagépek nem implementálják őket, ezért a meghívás előtt ellenőrizze, hogy létezik-e metódus. A jelen lévő metódusok nem jelentik azt, hogy a laphoz egy összekötő van kötve, vagy hogy a kapcsolat, az adatkészlet, a táblázat vagy a művelet a várt módon van konfigurálva, engedélyezve vagy engedélyezve.

A művelet- és függvénymetódusoktól eltérően az összekötő metódusok elutasítják a visszaadott ígéretet, ha egy hívás meghiúsul – például ha a kapcsolathivatkozás nem oldható fel, a kapcsolat nincs engedélyezve, és a felhasználó nem fejezi be a hozzájárulási kérést, vagy az összekötő hibaállapotot ad vissza. executeConnectorOperation ok: false a legtöbb hibaállapot esetén megoldódik, de továbbra is elutasítja egy hiányzó művelet, egy engedély nélküli kapcsolat (403) befejezését, vagy egy átviteli hibát. Összekötő-hívások körbefuttatása a fájlban try/catch

Method Description
createConnectorRow Új sort hoz létre a megadott összekötőtáblában.
deleteConnectorRow Töröl egy sort a megadott összekötőtáblából.
executeConnectorOperation Meghív egy rest (műveletkulcsú) összekötő által közzétett elnevezett műveletet, például Office 365 Felhasználók.
getConnectorSwagger Lekéri az összekötő Swagger (OpenAPI) definícióját.
getConnectorTableSchema Lekéri az összekötő által közzétett tábla (más néven entitás vagy lista) sémáját.
listConnectorDatasets Az összekötőhöz elérhető adatkészletek listája.
listConnectorOperations A REST (műveletkulcsos) összekötő által közzétett műveleteket sorolja fel.
listConnectorTables A megadott összekötő-adatkészletben elérhető táblákat sorolja fel.
queryConnectorTable Lekérdezi az összekötő által közzétett táblát a megadott beállításokkal.
retrieveConnectorRow Egyetlen sort kér le a megadott összekötőtáblából.
updateConnectorRow Frissíti a megadott összekötőtábla egy meglévő sorát.

queryConnectorTable módszer

Lekérdezi az összekötő által közzétett táblázatot a megadott beállítások használatával.

Parameters

Adja meg ezeknek a szükséges paramétereknek az értékeit.

Name Típus Description
connectorLogicalName string A laphoz kötött kapcsolathivatkozás logikai neve (például sp_shared_sharepointonline).
dataset string A táblát tartalmazó adatkészlet, például egy SharePoint webhely URL-címe.
tableName string A tábla belső neve a name visszaadott listConnectorTablestulajdonságból. Ne használja a megjelenítendő nevet.
options QueryConnectorTableOptions A tábla lekérdezésének beállításai.

QueryConnectorTableOptions

Name Típus Description
select string[] (Ajánlott) A lekérendő oszlopnevek tömbje.
filter string (Nem kötelező) Az összekötő által támogatott szűrőkifejezés.
orderBy string (Nem kötelező) Az összekötő által támogatott rendezés szerinti kifejezés.
top number (Nem kötelező) A visszaadandó sorok maximális száma.

Returns

A művelet eredményét tartalmazó ígéret . Ha a művelet sikeres, az ígéret egy adattáblát tartalmazó objektumot ad vissza az alábbi tulajdonságokkal:

Name Típus Description
rows Object[] Soradatok tömbje.
hasMoreRows boolean Azt jelzi, hogy több sor áll-e rendelkezésre.

queryConnectorTable egyetlen oldalnyi eredményt ad vissza. Nem ad vissza folytatási függvényt, és jelenleg nincs támogatott módja a következő oldal beolvasásának. Ha hasMoreRows igen true, több sor felel meg a visszaadottnál. Szűkítse a lekérdezést a következővel filter, vagy mondja meg a felhasználónak, hogy az eredmények hiányosak.

queryConnectorTable példa

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

Az alábbi példák feltételezik, hogy documentsTableName a tábla a fent látható módon származik namelistConnectorTables.

listConnectorTables módszer

A megadott összekötő-adatkészletben elérhető táblákat (listákat vagy entitásokat) sorolja fel.

Parameters

Adja meg ezeknek a szükséges paramétereknek az értékeit.

Name Típus Description
connectorLogicalName string A laphoz kötött kapcsolathivatkozás logikai neve.
dataset string A táblák listázásához használt adatkészlet.

Returns

Egy táblázatinformációs tömböt tartalmazó ígéret. Minden bejegyzés a következő tulajdonságokkal rendelkezik:

Name Típus Description
name string A tábla belső neve.
displayName string A tábla megjelenítendő neve.

listConnectorTables példa

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

listConnectorDatasets módszer

Felsorolja az összekötő számára elérhető adatkészleteket, például azokat a SharePoint helyeket, amelyekhez a kapcsolat hozzáférhet.

Parameters

Adjon meg egy értéket ehhez a kötelező paraméterhez.

Name Típus Description
connectorLogicalName string A laphoz kötött kapcsolathivatkozás logikai neve.

Returns

Adathalmaz-információkat tartalmazó ígéret . Minden bejegyzés a következő tulajdonságokkal rendelkezik:

Name Típus Description
name string Az adathalmaz belső neve vagy azonosítója.
displayName string Az adathalmaz megjelenítendő neve.

listConnectorDatasets példa

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

listConnectorOperations módszer

Az összekötő Swagger-definíciójában definiált műveleteket sorolja fel, kivéve a belsőként megjelölt műveleteket, megjelenítendő név szerint rendezve. Ez a módszer a rest (műveletkulcsos) összekötők, például a Office 365 Felhasználók esetében hasznos. Táblázatos összekötők esetén használja a lekérdezési és sormetódusokat a metódus által listázott műveletek helyett.

Parameters

Adjon meg egy értéket ehhez a kötelező paraméterhez.

Name Típus Description
connectorLogicalName string A laphoz kötött kapcsolathivatkozás logikai neve.

Returns

A műveletinformációk tömbjének ígérete. Minden bejegyzés a következő tulajdonságokkal rendelkezik:

Name Típus Description
name string Az összekötő Swagger-definíciójában meghatározott műveletazonosító. Adja át ezt az értéket a értéknek executeConnectorOperation.
displayName string A megjelenítendő, ember által olvasható művelet neve, például a Swagger-összegzés. Visszaesik, name ha nincs definiálva összegzés.

listConnectorOperations példa

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

getConnectorSwagger módszer

Lekéri az összekötő Swagger (OpenAPI) definícióját, amely leírja a feltárt műveleteket. A visszaadott dokumentum általánosan leírja az összekötőt. Táblázatos összekötők táblázatonkénti oszlopsémáit nem tartalmazza. Használja getConnectorTableSchema ezeket az információkat.

Parameters

Adjon meg egy értéket ehhez a kötelező paraméterhez.

Name Típus Description
connectorApiId string Az összekötő API-azonosítója, például /providers/Microsoft.PowerApps/apis/shared_sharepointonline. Ez az azonosító eltér a legtöbb más összekötő metódus által használt kapcsolathivatkozás logikai nevétől (connectorLogicalName).

Returns

Az összekötő Swagger-definícióját objektumként tartalmazó ígéret .

getConnectorSwagger példa

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 módszer

Lekéri az összekötő által közzétett táblák sémáját (oszlopdefinícióit). Az összekötő határozza meg a visszaadott sémát, és összekötőnként eltérő. Ne feltételezzük, hogy a tábla minden dinamikus oszlopát tartalmazza.

Parameters

Adja meg ezeknek a szükséges paramétereknek az értékeit.

Name Típus Description
connectorLogicalName string A laphoz kötött kapcsolathivatkozás logikai neve.
dataset string A táblát tartalmazó adatkészlet.
tableName string A tábla belső neve a name visszaadott listConnectorTablestulajdonságból. Ne használja a megjelenítendő nevet.

Returns

A tábla sémáját objektumként tartalmazó ígéret .

getConnectorTableSchema példa

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 módszer

Egyetlen sort kér le a megadott összekötőtáblából.

Parameters

Adja meg ezeknek a szükséges paramétereknek az értékeit.

Name Típus Description
connectorLogicalName string A laphoz kötött kapcsolathivatkozás logikai neve.
dataset string A táblát tartalmazó adatkészlet.
tableName string A tábla belső neve a name visszaadott listConnectorTablestulajdonságból. Ne használja a megjelenítendő nevet.
id string A lekérendő sor azonosítója.
options RetrieveConnectorRowOptions (Nem kötelező) A sor beolvasásának beállításai.

RetrieveConnectorRowOptions

Name Típus Description
select string[] (Ajánlott) A lekérendő oszlopnevek tömbje. Ha nincs megadva, a rendszer nem $select küld kivetülést – az összekötő határozza meg, hogy mely oszlopokat adja vissza, és nem garantálja, hogy a sor minden oszlopát visszaadja.

Returns

A soradatokat tartalmazó ígéret .

retrieveConnectorRow példa

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 módszer

Új sort hoz létre a megadott összekötőtáblában.

Parameters

Adja meg ezeknek a szükséges paramétereknek az értékeit.

Name Típus Description
connectorLogicalName string A laphoz kötött kapcsolathivatkozás logikai neve.
dataset string A táblát tartalmazó adatkészlet.
tableName string A tábla belső neve a name visszaadott listConnectorTablestulajdonságból. Ne használja a megjelenítendő nevet.
row object A létrehozandó soradatok.

Returns

Az összekötő által visszaadott választörzset tartalmazó ígéret , ha van ilyen. Az összekötőtől függően ez az érték lehet a létrehozott sor, egy részleges sor, vagy nincs érték.

createConnectorRow példa

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 módszer

Frissíti a megadott összekötőtábla egy meglévő sorát.

Parameters

Adja meg ezeknek a szükséges paramétereknek az értékeit.

Name Típus Description
connectorLogicalName string A laphoz kötött kapcsolathivatkozás logikai neve.
dataset string A táblát tartalmazó adatkészlet.
tableName string A tábla belső neve a name visszaadott listConnectorTablestulajdonságból. Ne használja a megjelenítendő nevet.
id string A frissíteni kívánt sor azonosítója.
row object A frissíteni kívánt soradatok.

Returns

Az összekötő által visszaadott választörzset tartalmazó ígéret , ha van ilyen. Az összekötőtől függően ez az érték lehet a frissített sor, egy részleges sor, vagy nincs érték. A sor aktuális értékeinek olvasásához hívja meg a következőt retrieveConnectorRow: .

updateConnectorRow példa

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 módszer

Töröl egy sort a megadott összekötőtáblából.

Parameters

Adja meg ezeknek a szükséges paramétereknek az értékeit.

Name Típus Description
connectorLogicalName string A laphoz kötött kapcsolathivatkozás logikai neve.
dataset string A táblát tartalmazó adatkészlet.
tableName string A tábla belső neve a name visszaadott listConnectorTablestulajdonságból. Ne használja a megjelenítendő nevet.
id string A törölni kívánt sor azonosítója.

Returns

A művelet eredményét tartalmazó ígéret . Ha a művelet sikeres, nem ad vissza értéket.

deleteConnectorRow példa

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 módszer

Meghív egy rest (műveletkulcsos) összekötő által közzétett elnevezett műveletet, például HTTP-t, Teams-küldési üzenetet vagy Office 365 Felhasználók. A táblázatos összekötőknek ehelyett a lekérdezési és sor-CRUD metódusokat kell használniuk.

Parameters

Adja meg ezeknek a szükséges paramétereknek az értékeit.

Name Típus Description
connectorLogicalName string A laphoz kötött kapcsolathivatkozás logikai neve.
operationName string Az összekötő Swagger-definíciójában meghatározott műveletazonosító.
parameters object A művelet által igényelt paraméterek. Adjon át egy üres objektumot ({}), ha a művelet nem használ paramétereket – ez a paraméter akkor is szükséges, ha nincs mit elküldeni.

Returns

Egy ígéret , amely a művelet eredményét tartalmazza ezekkel a tulajdonságokkal. Az ígéret elutasítja, ha a kapcsolati referenciát nem lehet feloldani, az összekötő Swagger-definíciója nem kérhető le, a művelet nem található benne, a hívás nem küldhető el, vagy a kapcsolat nincs engedélyezve (HTTP 403), és a felhasználó nem fejezi be a kapcsolati hozzájárulási kérést.

Name Típus Description
ok boolean true ha a mögöttes HTTP-állapot kisebb, mint 400. Ez az állapot átirányítási (3xx) állapotokat is tartalmaz, ezért ne kezelje ok egyedül a visszaadott művelet bizonyítékaként – ellenőrizze status vagy vizsgálja meg body.
status number Az összekötő által visszaadott nyers HTTP-állapotkód.
body unknown Az elemezett JSON-válasz törzse vagy a nyers sztring, ha a törzs nem JSON.

executeConnectorOperation példa

Az alábbi példa egy olyan műveletet CopyFile feltételez, amely elfogadja és destinationUrl paramétereket fogad elsourceUrl. A használat előtt ellenőrizze a művelet azonosítóját és paramétereit az összekötő saját Swagger-definíciójával (például a következővel listConnectorOperations vagy getConnectorSwagger) szemben, mivel az elérhető műveletek és paramétereik összekötőnként eltérőek.

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