Metódy konektora pre generatívne strany

Pomocou metód konektora dataApi objektu môžete pracovať s údajmi zverejnenými konektorom Power Platformy naviazaným na stranu.

Note

Metódy konektora sú v zdieľanej dataApi zmluve voliteľné. Niektorí hostitelia ich neimplementujú, takže pred volaním skontrolujte, či existuje metóda. Prítomná metóda neznamená, že na strane je naviazaný konektor alebo je pripojenie, množina údajov, tabuľka alebo operácia nakonfigurované, autorizované alebo povolené podľa očakávania.

Na rozdiel od metód akcie a funkcie zamietnú metódy konektora vrátený sľub, keď volanie zlyhá – napríklad keď odkaz na pripojenie nie je možné vyriešiť, pripojenie nie je oprávnené a používateľ nedokončí výzvu na zadanie súhlasu alebo konektor vráti stav chyby. executeConnectorOperation ok: false riešenie pre väčšinu stavov chýb, ale napriek tomu odmieta pre chýbajúcu operáciu, neoprávnené pripojenie (403) bez dokončeného súhlasu alebo zlyhanie prenosu. Zalomte volania konektora v try/catch.

Metóda Description
createConnectorRow Vytvorí nový riadok v zadanej tabuľke konektora.
deleteConnectorRow Odstráni riadok zo zadanej tabuľky konektora.
executeConnectorOperation Vyvolá pomenovanú operáciu vystavenú konektorom REST (s kľúčom operácie), napríklad Používatelia pre Office 365.
getConnectorSwagger Načíta definíciu súboru Swagger (OpenAPI) pre konektor.
getConnectorTableSchema Načíta schému tabuľky (nazývanej aj entita alebo zoznam) zobrazenú konektorom.
listConnectorDatasets Uvádza zoznam množín údajov dostupných pre konektor.
listConnectorOperations Zobrazí zoznam operácií exponovaných konektorom REST (s kľúčom operácie).
listConnectorTables Uvádza zoznam tabuliek dostupných v zadanej množine údajov konektora.
queryConnectorTable Dotazuje tabuľku zobrazenú konektorom so zadanými možnosťami.
retrieveConnectorRow Načíta jeden riadok zo zadanej tabuľky konektora.
updateConnectorRow Aktualizuje existujúci riadok v zadanej tabuľke konektora.

queryConnectorTable metóda

Dotazuje tabuľku zobrazenú konektorom pomocou zadaných možností.

Parametre

Nastavte hodnoty pre tieto povinné parametre.

Name Type Description
connectorLogicalName string Logický názov odkazu na pripojenie naviazaného na stránku (napríklad sp_shared_sharepointonline).
dataset string Množina údajov, ktorá obsahuje tabuľku, napríklad URL adresa lokality SharePoint.
tableName string Interný názov tabuľky z vlastnosti vrátenej name funkciou listConnectorTables. Nepoužívajte zobrazovaný názov.
options QueryConnectorTableMožnosti Možnosti dotazovania tabuľky.

QueryConnectorTableMožnosti

Name Type Description
select string[] (Odporúča sa) Pole názvov stĺpcov, ktoré sa majú načítať.
filter string (Voliteľné) Výraz filtra podporovaný konektorom.
orderBy string (Voliteľné) Výraz Order-by podporovaný konektorom.
top number (Voliteľné) Maximálny počet riadkov, ktoré sa majú vrátiť.

Vrátené hodnoty

Sľub obsahujúci výsledok operácie. Po úspešnej operácii vráti sľub objekt obsahujúci tabuľku údajov s výsledkami s týmito vlastnosťami:

Name Type Description
rows Object[] Pole údajov riadkov.
hasMoreRows boolean Udáva, či je k dispozícii viac riadkov.

queryConnectorTable Vráti jednu stranu výsledkov. Nevráti pokračovanú funkciu a v súčasnosti neexistuje žiadny podporovaný spôsob načítania ďalšej stránky. Hodnota je true, kedy sa hasMoreRows našla zhoda viac riadkov, ako bolo vrátených. Zmenšite dotaz na filterhodnotu alebo povedzte používateľovi, že výsledky sú neúplné.

príklad tabuľky 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,
  }
);

Nasledujúce príklady predpokladajú, že documentsTableName tabuľka pochádza name z listConnectorTablestabuľky , ako je to znázornené vyššie.

listConnectorTables metóda

Obsahuje zoznam tabuliek (zoznamov alebo entít) dostupných v zadanej množine údajov konektora.

Parametre

Nastavte hodnoty pre tieto povinné parametre.

Name Type Description
connectorLogicalName string Logický názov odkazu na pripojenie naviazaného na stránku.
dataset string Množina údajov, pre ktorá sa majú zobrazovať zoznam tabuliek.

Vrátené hodnoty

Sľub obsahujúci pole informácií o tabuľke. Každá položka má tieto vlastnosti:

Name Type Description
name string Interný názov tabuľky.
displayName string Zobrazovaný názov tabuľky.

príklad listConnectorTables

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

listConnectorDatasets metóda

Zoznam množín údajov dostupných pre konektor, ako sú napríklad SharePoint lokality, ku ktorých má pripojenie prístup.

Parametre

Nastavte hodnotu pre tento povinný parameter.

Name Type Description
connectorLogicalName string Logický názov odkazu na pripojenie naviazaného na stránku.

Vrátené hodnoty

Sľub, ktorý obsahuje pole informácií o množine údajov. Každá položka má tieto vlastnosti:

Name Type Description
name string Interný názov alebo identifikátor množiny údajov.
displayName string Zobrazovaný názov množiny údajov.

príklad listConnectorDatasets (zoznamPripojiť množiny údajov)

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

listConnectorOperations metóda

Zobrazí zoznam operácií definovaných v definícii Swagger konektora okrem operácií označených ako interné, zoradené podľa zobrazovaného názvu. Táto metóda je najužitočnejšia pre konektory REST (s kľúčom operácie), napríklad Používatelia pre Office 365. Pre tabuľkové konektory použite namiesto operácií, ktoré táto metóda uvádza, metódu dotazu a riadka.

Parametre

Nastavte hodnotu pre tento povinný parameter.

Name Type Description
connectorLogicalName string Logický názov odkazu na pripojenie naviazaného na stránku.

Vrátené hodnoty

Sľub obsahujúci pole informácií o operácii. Každá položka má tieto vlastnosti:

Name Type Description
name string ID operácie definované v definícii Swagger konektora. Preneste túto hodnotu do .executeConnectorOperation
displayName string Názov operácie čitateľnej pre ľudí na zobrazenie, napríklad súhrn Swagger. Ak nie je definovaný žiadny súhrn, vráti sa späť na name .

príklad listConnectorOperations

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

getConnectorSwagger metóda

Načíta definíciu súboru Swagger (OpenAPI) pre konektor, ktorá popisuje operácie, ktoré sprístupňuje. Vrátený dokument popisuje konektor celkovo. Nezahŕňa schémy stĺpcov pre tabuľkové konektory na tabuľkové. Použite getConnectorTableSchema pre tieto informácie.

Parametre

Nastavte hodnotu pre tento povinný parameter.

Name Type Description
connectorApiId string Identifikátor rozhrania API konektora, napríklad /providers/Microsoft.PowerApps/apis/shared_sharepointonline. Tento identifikátor sa líši od logického názvu odkazu na pripojenie (connectorLogicalName), ktorý používa väčšina ostatných metód konektora.

Vrátené hodnoty

Sľub, ktorý obsahuje definíciu Swagger konektora ako objekt.

príklad 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 metóda

Načíta schému (definície stĺpcov) pre tabuľku, ktorú zobrazuje konektor. Konektor definuje schému, ktorú vráti, a líši sa podľa konektora. Nepredpokladajte, že obsahuje každý dynamický stĺpec, ktorý by tabuľka mohla obsahovať.

Parametre

Nastavte hodnoty pre tieto povinné parametre.

Name Type Description
connectorLogicalName string Logický názov odkazu na pripojenie naviazaného na stránku.
dataset string Množina údajov, ktorá obsahuje tabuľku.
tableName string Interný názov tabuľky z vlastnosti vrátenej name funkciou listConnectorTables. Nepoužívajte zobrazovaný názov.

Vrátené hodnoty

Sľub, ktorý obsahuje schému tabuľky ako objekt.

príklad získať schému 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 metóda

Načíta jeden riadok zo zadanej tabuľky konektora.

Parametre

Nastavte hodnoty pre tieto povinné parametre.

Name Type Description
connectorLogicalName string Logický názov odkazu na pripojenie naviazaného na stránku.
dataset string Množina údajov, ktorá obsahuje tabuľku.
tableName string Interný názov tabuľky z vlastnosti vrátenej name funkciou listConnectorTables. Nepoužívajte zobrazovaný názov.
id string ID riadka, ktorý sa má načítať.
options Načítanie tabuliekConnectorRowOptions (Voliteľné) Možnosti načítania riadka.

Načítanie tabuliekConnectorRowOptions

Name Type Description
select string[] (Odporúča sa) Pole názvov stĺpcov, ktoré sa majú načítať. V prípade vynechania sa neodošle žiadna $select projekcia – konektor určí, ktoré stĺpce sa majú vrátiť, a nezaručuje, že sa vráti každý stĺpec v riadku.

Vrátené hodnoty

Sľub obsahujúci údaje riadka.

príklad načítania dotazuConnectorRow

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 metóda

Vytvorí nový riadok v zadanej tabuľke konektora.

Parametre

Nastavte hodnoty pre tieto povinné parametre.

Name Type Description
connectorLogicalName string Logický názov odkazu na pripojenie naviazaného na stránku.
dataset string Množina údajov, ktorá obsahuje tabuľku.
tableName string Interný názov tabuľky z vlastnosti vrátenej name funkciou listConnectorTables. Nepoužívajte zobrazovaný názov.
row object Údaje riadka, ktoré sa majú vytvoriť.

Vrátené hodnoty

Sľub obsahujúci telo odpovede vrátené konektorom, ak existuje. V závislosti od konektora môže byť touto hodnotou vytvorený riadok, čiastočný riadok alebo žiadna hodnota.

príklad 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 metóda

Aktualizuje existujúci riadok v zadanej tabuľke konektora.

Parametre

Nastavte hodnoty pre tieto povinné parametre.

Name Type Description
connectorLogicalName string Logický názov odkazu na pripojenie naviazaného na stránku.
dataset string Množina údajov, ktorá obsahuje tabuľku.
tableName string Interný názov tabuľky z vlastnosti vrátenej name funkciou listConnectorTables. Nepoužívajte zobrazovaný názov.
id string ID riadka, ktorý sa má aktualizovať.
row object Údaje riadka, ktoré sa majú aktualizovať.

Vrátené hodnoty

Sľub obsahujúci telo odpovede vrátené konektorom, ak existuje. V závislosti od konektora môže byť touto hodnotou aktualizovaný riadok, čiastočný riadok alebo žiadna hodnota. Ak chcete čítať aktuálne hodnoty riadka, zavolajte .retrieveConnectorRow

príklad 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 metóda

Odstráni riadok zo zadanej tabuľky konektora.

Parametre

Nastavte hodnoty pre tieto povinné parametre.

Name Type Description
connectorLogicalName string Logický názov odkazu na pripojenie naviazaného na stránku.
dataset string Množina údajov, ktorá obsahuje tabuľku.
tableName string Interný názov tabuľky z vlastnosti vrátenej name funkciou listConnectorTables. Nepoužívajte zobrazovaný názov.
id string ID riadka, ktorý sa má odstrániť.

Vrátené hodnoty

Sľub obsahujúci výsledok operácie. Keď je operácia úspešná, nevráti žiadnu hodnotu.

príklad odstránenia položky PripojiťZmluv

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 metóda

Vyvolá pomenovanú operáciu vystavenú konektorom REST (s kľúčom operácie), ako je napríklad odosielanie správ HTTP, Teams alebo Používatelia pre Office 365. Tabuľkové konektory by namiesto toho mali používať metódy dotazu a riadka CRUD.

Parametre

Nastavte hodnoty pre tieto povinné parametre.

Name Type Description
connectorLogicalName string Logický názov odkazu na pripojenie naviazaného na stránku.
operationName string ID operácie definované v definícii Swagger konektora.
parameters object Parametre vyžadované operáciou. Ak operácia nevyžaduje žiadne parametre, odovzdajte prázdny objekt ({}). Tento parameter sa vyžaduje aj vtedy, keď nie je potrebné nič odoslať.

Vrátené hodnoty

Sľub obsahujúci výsledok operácie s týmito vlastnosťami. Sľub odmietne, ak sa odkaz na pripojenie nedá vyriešiť, nie je možné načítať definíciu Swagger konektora, operácia sa v nej nenájde, volanie sa nedá odoslať alebo pripojenie nie je oprávnené (HTTP 403) a používateľ nedokončí výzvu na súhlas pripojenia.

Name Type Description
ok boolean true keď je základný stav protokolu HTTP menší ako 400. Tento stav zahŕňa stavy presmerovania (3xx), takže sa nekladú ok samostatne ako dôkaz o vrátených údajoch operácie – tiež kontrolujte status alebo kontrolujte body.
status number Nespracovaný kód stavu HTTP, ktorý konektor vráti.
body unknown Analyzovaná časť tela odpovede JSON alebo nespracovaný reťazec, ak telo nie je JSON.

príklad executeConnectorOperation

V nasledujúcom príklade sa predpokladá operácia s názvom CopyFile , ktorá prijíma sourceUrl parametre a destinationUrl . Pred použitím overte ID operácie a jej parametre v definícii vlastného Swagger konektora (napríklad s listConnectorOperations alebo getConnectorSwagger), pretože dostupné operácie a ich parametre sa líšia podľa konektora.

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