Generatiivsete lehtede konnektorimeetodid

Kasutage objekti konnektorimeetodeid dataApi lehega seotud Power Platformi konnektori andmetega töötamiseks.

Märkus.

Konnektorimeetodid on ühislepingus dataApi valikulised. Mõned hostid ei juuruta neid, seega kontrollige enne kutsumist, kas mõni meetod on olemas. Kasutatav meetod ei tähenda, et lehega on seotud konnektor või et ühendus, andmekomplekt, tabel või toiming on konfigureeritud, autoriseeritud või lubatud ootuspäraselt.

Erinevalt toimingu- ja funktsioonimeetoditest lükkavad konnektorimeetodid tagasi tagastatud lubaduse, kui kõne nurjub – näiteks kui ühenduse viidet ei saa lahendada, pole ühendus lubatud ja kasutaja ei vii nõusoleku küsimist lõpule või konnektor tagastab tõrkeoleku. executeConnectorOperation lahendab ok: false enamiku tõrkeolekute korral, kuid lükkab siiski puuduva toimingu, loata ühenduse (403) ilma lõpliku nõusolekuta või transporditõrke tõttu tagasi. Wrap connector calls in try/catch.

Meetod	Kirjeldus
createConnectorRow	Loob määratud konnektoritabelis uue rea.
deleteConnectorRow	Kustutab määratud konnektoritabelist rea.
executeConnectorOperation	Käivitab REST-i (toiminguklahviga) konnektori avatud nimega toimingu (nt Office 365 kasutajad).
getConnectorSwagger	Toob konnektori Swaggeri (OpenAPI) definitsiooni.
getConnectorTableSchema	Toob konnektori esitatud tabeli (ehk olemi või loendi) skeemi.
listConnectorDatasets	Loetleb konnektori jaoks saadaolevad andmekomplektid.
listConnectorOperations	Loetleb REST-i (toiminguklahviga) konnektori kuvatavad toimingud.
listConnectorTables	Loetleb määratud konnektori andmekomplektis saadaolevad tabelid.
queryConnectorTable	Esitab konnektori esitatud tabelile määratud suvanditega päringud.
retrieveConnectorRow	Toob määratud konnektoritabelist ühe rea.
updateConnectorRow	Värskendab määratud konnektoritabelis olemasoleva rea.

queryConnectorTable Meetod

Esitab konnektori poolt määratud suvandite abil esitatud tabelipäringu.

Parameetrid

Seadke nende nõutavate parameetrite väärtused.

Nimi	Tüüp	Kirjeldus
connectorLogicalName	string	Lehega seotud ühenduseviite loogikanimi (nt sp_shared_sharepointonline).
dataset	string	Tabelit sisaldav andmekomplekt (nt SharePoint saidi URL).
tableName	string	Tabeli sisemine nimi tagastatud namelistConnectorTablesatribuudist. Ärge kasutage kuvatavat nime.
options	QueryConnectorTableOptions	Tabelipäringu suvandid.

QueryConnectorTableOptions

Nimi	Tüüp	Kirjeldus
select	string[]	(Soovitatav) Toodavate veerunimede massiiv.
filter	string	(Valikuline) Konnektori toetatav filtriavaldis.
orderBy	string	(Valikuline) Konnektor toetab järjestuse avaldist.
top	number	(Valikuline) Tagastatavate ridade maksimumarv.

Tagastused

Lubadus, mis sisaldab operatsiooni tulemust. Kui toiming õnnestub, tagastab lubadus järgmise atribuudiga andmetabelit sisaldava objekti:

Nimi	Tüüp	Kirjeldus
rows	Object[]	Reaandmete massiiv.
hasMoreRows	boolean	Näitab, kas saadaval on rohkem ridu.

queryConnectorTable tagastab ühe tulemilehe. See ei tagasta jätkufunktsiooni ja praegu ei toetata järgmise lehe toomist. Kui hasMoreRows on true, vastendati rohkem ridu, kui tagastati. Piiritlege päringut funktsiooniga filtervõi öelge kasutajale, et tulemid pole täielikud.

queryConnectorTable example

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

Järgmistes näidetes eeldatakse, et documentsTableName tabelid pärinevad name failist listConnectorTables, nagu eespool näidatud.

listConnectorTables Meetod

Loetleb määratud konnektori andmekomplektis saadaolevad tabelid (loendid või olemid).

Parameetrid

Seadke nende nõutavate parameetrite väärtused.

Nimi	Tüüp	Kirjeldus
connectorLogicalName	string	Lehega seotud ühenduseviite loogikanimi.
dataset	string	Andmekomplekt, mille jaoks tabeleid loetletakse.

Tagastused

Lubadus, mis sisaldab massiivi tabeliteavet. Igal kirjel on järgmised atribuudid.

Nimi	Tüüp	Kirjeldus
name	string	Tabeli sisemine nimi.
displayName	string	Tabeli kuvatav nimi.

listConnectorTables example

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

listConnectorDatasets Meetod

Siin on loetletud konnektori jaoks saadaolevad andmekomplektid (nt SharePoint saidid, millel ühendus juurde pääseb).

Parameetrid

Määrake selle nõutava parameetri väärtus.

Nimi	Tüüp	Kirjeldus
connectorLogicalName	string	Lehega seotud ühenduseviite loogikanimi.

Tagastused

Andmekomplekti teavet sisaldav lubadus. Igal kirjel on järgmised atribuudid.

Nimi	Tüüp	Kirjeldus
name	string	Andmekomplekti sisemine nimi või identifikaator.
displayName	string	Andmekomplekti kuvatav nimi.

listConnectorDatasets example

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

listConnectorOperations Meetod

Loetleb konnektori Swagger-määratluses määratletud toimingud, v.a sisemised toimingud, mis on sorditud kuvatava nime järgi. See meetod on kõige kasulikum REST-i (toiminguklahviga) konnektorite (nt Office 365 kasutajad) puhul. Tabelikonnektorite puhul kasutage selle meetodi loendi toimingute asemel päringu- ja reameetodeid.

Parameetrid

Määrake selle nõutava parameetri väärtus.

Nimi	Tüüp	Kirjeldus
connectorLogicalName	string	Lehega seotud ühenduseviite loogikanimi.

Tagastused

Lubadus, mis sisaldab palju tööteavet. Igal kirjel on järgmised atribuudid.

Nimi	Tüüp	Kirjeldus
name	string	Toimingu ID, nagu määratletud konnektori Swagger-määratluses. Edastage see väärtus aadressile executeConnectorOperation.
displayName	string	Kuvatav inimloetava toimingu nimi (nt Swagger kokkuvõte). Läheb tagasi, name kui kokkuvõtet pole määratletud.

listConnectorOperations example

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

getConnectorSwagger Meetod

Toob konnektori Swaggeri (OpenAPI) määratluse, mis kirjeldab kuvatavaid toiminguid. Tagastatud dokument kirjeldab konnektori üldjoont. See ei sisalda tabelikohaseid veeruskeeme tabelite konnektorite jaoks. Kasutage getConnectorTableSchema seda teavet.

Parameetrid

Määrake selle nõutava parameetri väärtus.

Nimi	Tüüp	Kirjeldus
connectorApiId	string	Konnektori API identifikaator, nt /providers/Microsoft.PowerApps/apis/shared_sharepointonline. See identifikaator erineb enamiku muude konnektorimeetodite kasutatavast ühenduseviite loogikanimest (connectorLogicalName).

Tagastused

Lubadus, mis sisaldab konnektori Swaggeri määratlust objektina.

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 Meetod

Toob konnektori esitatud tabeli skeemi (veerumääratlused). Konnektor määratleb tagastatava skeemi ja erineb konnektori lõikes. Ärge eeldage, et see sisaldab kõiki dünaamilisi veerge, mida tabel võib sisaldada.

Parameetrid

Seadke nende nõutavate parameetrite väärtused.

Nimi	Tüüp	Kirjeldus
connectorLogicalName	string	Lehega seotud ühenduseviite loogikanimi.
dataset	string	Tabelit sisaldav andmekomplekt.
tableName	string	Tabeli sisemine nimi tagastatud namelistConnectorTablesatribuudist. Ärge kasutage kuvatavat nime.

Tagastused

Lubadus, mis sisaldab tabeli skeemi objektina.

getConnectorTableSchema example

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 Meetod

Toob määratud konnektoritabelist ühe rea.

Parameetrid

Seadke nende nõutavate parameetrite väärtused.

Nimi	Tüüp	Kirjeldus
connectorLogicalName	string	Lehega seotud ühenduseviite loogikanimi.
dataset	string	Tabelit sisaldav andmekomplekt.
tableName	string	Tabeli sisemine nimi tagastatud namelistConnectorTablesatribuudist. Ärge kasutage kuvatavat nime.
id	string	Toodava rea ID.
options	RetrieveConnectorRowOptions	(Valikuline) Rea toomise suvandid.

RetrieveConnectorRowOptions

Nimi	Tüüp	Kirjeldus
select	string[]	(Soovitatav) Toodavate veerunimede massiiv. Kui see puudub, siis projektsiooni ei $select saadeta – konnektor määratleb, millised veerud tagastada, ega taga iga reaveeru tagastamist.

Tagastused

Reaandmeid sisaldav lubadus.

retrieveConnectorRow example

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 Meetod

Loob määratud konnektoritabelis uue rea.

Parameetrid

Seadke nende nõutavate parameetrite väärtused.

Nimi	Tüüp	Kirjeldus
connectorLogicalName	string	Lehega seotud ühenduseviite loogikanimi.
dataset	string	Tabelit sisaldav andmekomplekt.
tableName	string	Tabeli sisemine nimi tagastatud namelistConnectorTablesatribuudist. Ärge kasutage kuvatavat nime.
row	object	Loodavad reaandmed.

Tagastused

Lubadus, mis sisaldab konnektori tagastatud vastusekeha, kui see on olemas. Olenevalt konnektori väärtusest võib see väärtus olla loodud rida, osaline rida või väärtuseta.

createConnectorRow example

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 Meetod

Värskendab määratud konnektoritabelis olemasoleva rea.

Parameetrid

Seadke nende nõutavate parameetrite väärtused.

Nimi	Tüüp	Kirjeldus
connectorLogicalName	string	Lehega seotud ühenduseviite loogikanimi.
dataset	string	Tabelit sisaldav andmekomplekt.
tableName	string	Tabeli sisemine nimi tagastatud namelistConnectorTablesatribuudist. Ärge kasutage kuvatavat nime.
id	string	Värskendatava rea ID.
row	object	Värskendatavad reaandmed.

Tagastused

Lubadus, mis sisaldab konnektori tagastatud vastusekeha, kui see on olemas. Olenevalt konnektori väärtusest võib see väärtus olla värskendatud rida, osaline rida või väärtuseta. Rea praeguste väärtuste lugemiseks helistage retrieveConnectorRow.

updateConnectorRow example

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 Meetod

Kustutab määratud konnektoritabelist rea.

Parameetrid

Seadke nende nõutavate parameetrite väärtused.

Nimi	Tüüp	Kirjeldus
connectorLogicalName	string	Lehega seotud ühenduseviite loogikanimi.
dataset	string	Tabelit sisaldav andmekomplekt.
tableName	string	Tabeli sisemine nimi tagastatud namelistConnectorTablesatribuudist. Ärge kasutage kuvatavat nime.
id	string	Kustutatava rea ID.

Tagastused

Lubadus, mis sisaldab operatsiooni tulemust. Toimingu õnnestumisel ei tagastata väärtust.

deleteConnectorRow example

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 Meetod

Käivitab REST-i (toiminguklahviga) konnektori (nt HTTP, Teamsi saatmissõnumi või Office 365 kasutajad) avaldatud nimega toimingu. Tabelikonnektorid peaksid selle asemel kasutama päringut ja rea CRUD-meetodeid.

Parameetrid

Seadke nende nõutavate parameetrite väärtused.

Nimi	Tüüp	Kirjeldus
connectorLogicalName	string	Lehega seotud ühenduseviite loogikanimi.
operationName	string	Toimingu ID, nagu määratletud konnektori Swagger-määratluses.
parameters	object	Toimingu nõutavad parameetrid. Kui toiming ei võta parameetreid, edastage tühi objekt ({}) – see parameeter on nõutav ka siis, kui midagi saata pole.

Tagastused

Lubadus, mis sisaldab nende omadustega toimingu tulemust. Lubadus hüljatakse, kui ühenduse viidet ei saa lahendada, konnektori Swaggeri määratlust ei saa tuua, toimingut selles ei leita, kõnet ei saa saata või ühendus pole lubatud (HTTP 403) ja kasutaja ei täida ühenduse nõusoleku viipa.

Nimi	Tüüp	Kirjeldus
ok	boolean	true kui aluseks olev HTTP-olek on väiksem kui 400. See olek sisaldab ümbersuunamise (3xx) olekuid, nii et ärge käsitlege ok üksi tõendina tagastatud toimingu andmeid – kontrollige status või kontrollige body.
status	number	Konnektori tagastatud HTTP-tooroleku kood.
body	unknown	Sõelutud JSON-vastuse keha või toorstring, kui keha pole JSON.

executeConnectorOperation example

Järgmises näites eeldatakse toimingut nimega CopyFile , mis aktsepteerib sourceUrl ja destinationUrl parameetrid. Enne selle kasutamist kontrollige toimingu ID-d ja selle parameetreid konnektori enda Swaggeri määratlusega (nt koos listConnectorOperations või getConnectorSwagger), kuna saadaolevad toimingud ja nende parameetrid erinevad konnektori järgi.

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