Jungties metodai generuojamiesiems puslapiams

Naudokite objekto jungties metodus dataApi , kad galėtumėte dirbti su duomenimis, kuriuos rodo "Power Platform" jungtis, susieta su puslapiu.

Banknotas

Jungties metodai bendrai naudojamoje dataApi sutartyje yra pasirinktiniai. Kai kurie pagrindiniai kompiuteriai jų neįdiegia, todėl prieš skambindami patikrinkite, ar yra metodas. Esantis metodas nereiškia, kad puslapis turi su juo susietą jungtį arba kad ryšys, duomenų rinkinys, lentelė ar operacija sukonfigūruota, autorizuota arba leidžiama, kaip numatyta.

Skirtingai nei veiksmo ir funkcijų metodai, jungties metodai atmeta grąžintą pažadą, kai skambutis nepavyksta, pvz., kai nepavyksta išspręsti ryšio nuorodos, ryšys nėra įgaliotas ir vartotojas nepateikia sutikimo raginimo arba jungtis pateikia klaidos būseną. executeConnectorOperation išsprendžiama naudojant ok: false daugumą klaidų būsenų, tačiau vis tiek atmetama dėl trūkstamos operacijos, neteisėto ryšio (403) be užbaigto sutikimo arba transportavimo trikties. Wrap connector calls in try/catch.

Metodas	Aprašas
createConnectorRow	Nurodytoje jungčių lentelėje sukuria naują eilutę.
deleteConnectorRow	Panaikina eilutę iš nurodytos jungties lentelės.
executeConnectorOperation	Iškviečia įvardytąją operaciją, kurią veikia REST (operacijos klavišo) jungtis, pvz., „Office 365“ vartotojai.
getConnectorSwagger	Nuskaito jungties "Swagger" (OpenAPI) apibrėžimą.
getConnectorTableSchema	Nuskaito jungties rodomos lentelės (dar vadinamos objektu arba sąrašu) schemą.
listConnectorDatasets	Išvardijami galimi jungties duomenų rinkiniai.
listConnectorOperations	Išvardijamos operacijos, kurias veikia REST (operacijos klavišas) jungtis.
listConnectorTables	Išvardijamos lentelės, galimos nurodytame jungčių duomenų rinkinyje.
queryConnectorTable	Pateikia užklausą lentelei, kurią rodo jungtis su nurodytomis parinktimis.
retrieveConnectorRow	Nuskaito vieną eilutę iš nurodytos jungties lentelės.
updateConnectorRow	Atnaujina esamą eilutę nurodytoje jungčių lentelėje.

queryConnectorTable metodas

Pateikia užklausą lentelei, kurią rodo jungtis, naudodama nurodytas parinktis.

Parametrai

Nustatykite šių būtinų parametrų reikšmes.

Pavadinimas / vardas ir pavardė	Tipas	Aprašas
connectorLogicalName	string	Su puslapiu susietos ryšio nuorodos loginis pavadinimas (pvz., sp_shared_sharepointonline).
dataset	string	Duomenų rinkinys, kuriame yra lentelė, pvz., SharePoint svetainės URL.
tableName	string	Lentelės vidinis pavadinimas iš name ypatybės, kurią listConnectorTablesgrąžino . Nenaudokite rodomo vardo.
options	QueryConnectorTableOptions	Lentelės užklausos parinktys.

QueryConnectorTableOptions

Pavadinimas / vardas ir pavardė	Tipas	Aprašas
select	string[]	(Rekomenduojama) Nuskaitomų stulpelių pavadinimų masyvas.
filter	string	(Pasirinktinai) Jungties palaikoma filtro išraiška.
orderBy	string	(Pasirinktinai) Jungties palaikomas reiškinys Order-by.
top	number	(Pasirinktinai) Maksimalus grąžintinų eilučių skaičius.

Grąžinimai

Pažadas, kuriame pateikiamas operacijos rezultatas. Kai operacija pavyksta, pažadas pateikia objektą, kuriame yra duomenų lentelė su šių ypatybių rezultatais:

Pavadinimas / vardas ir pavardė	Tipas	Aprašas
rows	Object[]	Eilučių duomenų masyvas.
hasMoreRows	boolean	Nurodo, ar yra daugiau galimų eilučių.

queryConnectorTable pateikia vieną rezultatų puslapį. Ji negrąžina tęsimo funkcijos ir šiuo metu nėra palaikomo būdo iškviesti kitą puslapį. Kai hasMoreRows yra true, daugiau atitikmenų eilučių, nei buvo pateikta. Susiaurinkite užklausą naudodami filterarba praneškite vartotojui, kad rezultatai yra neišsamūs.

queryConnectorTable pavyzdys

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

Toliau pateiktuose pavyzdžiuose daroma prielaida documentsTableName , kad lentelė name yra iš listConnectorTables, kaip parodyta anksčiau.

listConnectorTables metodas

Išvardijamos lentelės (sąrašai arba objektai), galimi nurodytame jungčių duomenų rinkinyje.

Parametrai

Nustatykite šių būtinų parametrų reikšmes.

Pavadinimas / vardas ir pavardė	Tipas	Aprašas
connectorLogicalName	string	Loginis ryšio nuorodos, susietos su puslapiu, pavadinimas.
dataset	string	Duomenų rinkinys lentelėms išvardyti.

Grąžinimai

Pažadas, kuriame yra lentelės informacijos masyvas. Kiekvienas įrašas turi šias ypatybes:

Pavadinimas / vardas ir pavardė	Tipas	Aprašas
name	string	Vidinis lentelės pavadinimas.
displayName	string	Rodomas lentelės pavadinimas.

listConnectorTables pavyzdys

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

listConnectorDatasets metodas

Išvardijami galimi jungties duomenų rinkiniai, pvz., SharePoint svetainėms, prie kurių gali prisijungti ryšys.

Parametrai

Nustatykite šio būtino parametro reikšmę.

Pavadinimas / vardas ir pavardė	Tipas	Aprašas
connectorLogicalName	string	Loginis ryšio nuorodos, susietos su puslapiu, pavadinimas.

Grąžinimai

Pažadas, kuriame yra duomenų rinkinio informacijos masyvas. Kiekvienas įrašas turi šias ypatybes:

Pavadinimas / vardas ir pavardė	Tipas	Aprašas
name	string	Duomenų rinkinio vidinis pavadinimas arba identifikatorius.
displayName	string	Rodomas duomenų rinkinio pavadinimas.

listConnectorDatasets pavyzdys

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

listConnectorOperations metodas

Išvardijamos operacijos, apibrėžtos jungties "Swagger" apibrėžime, išskyrus operacijas, pažymėtas kaip vidinės, surūšiuotos pagal rodomą pavadinimą. Šis metodas yra naudingiausias REST (operacijos klavišų) jungčioms, pvz., „Office 365“ vartotojai. Lentelės formos jungčioms naudokite užklausos ir eilutės metodus, o ne šio metodo sąrašų operacijas.

Parametrai

Nustatykite šio būtino parametro reikšmę.

Pavadinimas / vardas ir pavardė	Tipas	Aprašas
connectorLogicalName	string	Loginis ryšio nuorodos, susietos su puslapiu, pavadinimas.

Grąžinimai

Pažadas, kuriame yra operacijos informacijos masyvas. Kiekvienas įrašas turi šias ypatybes:

Pavadinimas / vardas ir pavardė	Tipas	Aprašas
name	string	Operacijos ID, kaip apibrėžta jungties "Swagger" apibrėžime. Perduoti šią reikšmę .executeConnectorOperation
displayName	string	Rodomas žmogaus skaitomas operacijos pavadinimas, pvz., "Swagger" suvestinė. Grąžinama, name jei suvestinė neapibrėžta.

listConnectorOperations example

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

getConnectorSwagger metodas

Nuskaito jungties "Swagger" (OpenAPI) apibrėžimą, kuriame aprašomos jo atskleidžiamos operacijos. Grąžintame dokumente aprašoma bendra jungtis. Ji neapima lentelės stulpelių schemų, skirtų lentelės jungčioms. Naudokite getConnectorTableSchema šiai informacijai gauti.

Parametrai

Nustatykite šio būtino parametro reikšmę.

Pavadinimas / vardas ir pavardė	Tipas	Aprašas
connectorApiId	string	Jungties API identifikatorius, pvz /providers/„Microsoft“.PowerApps/apis/shared_sharepointonline., . Šis identifikatorius skiriasi nuo ryšio nuorodos loginio pavadinimo (connectorLogicalName), naudojamo daugumoje kitų jungties metodų.

Grąžinimai

Pažadas, kuriame yra jungties "Swagger" apibrėžimas kaip objektas.

getConnectorSwagger pavyzdys

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 metodas

Nuskaito jungtyje esančios lentelės schemą (stulpelių apibrėžimus). Jungtis apibrėžia grąžinamą schemą ir skiriasi atsižvelgiant į jungtį. Nemanykime, kad joje yra kiekvienas dinaminis stulpelis, kuriame gali būti lentelė.

Parametrai

Nustatykite šių būtinų parametrų reikšmes.

Pavadinimas / vardas ir pavardė	Tipas	Aprašas
connectorLogicalName	string	Loginis ryšio nuorodos, susietos su puslapiu, pavadinimas.
dataset	string	Duomenų rinkinys, kuriame yra lentelė.
tableName	string	Lentelės vidinis pavadinimas iš name ypatybės, kurią listConnectorTablesgrąžino . Nenaudokite rodomo vardo.

Grąžinimai

Pažadas, kuriame yra lentelės schema kaip objektas.

getConnectorTableSchema pavyzdys

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 metodas

Nuskaito vieną eilutę iš nurodytos jungties lentelės.

Parametrai

Nustatykite šių būtinų parametrų reikšmes.

Pavadinimas / vardas ir pavardė	Tipas	Aprašas
connectorLogicalName	string	Loginis ryšio nuorodos, susietos su puslapiu, pavadinimas.
dataset	string	Duomenų rinkinys, kuriame yra lentelė.
tableName	string	Lentelės vidinis pavadinimas iš name ypatybės, kurią listConnectorTablesgrąžino . Nenaudokite rodomo vardo.
id	string	Gautinų eilučių ID.
options	RetrieveConnectorRowOptions	(Pasirinktinai) Eilutės nuskaitymo parinktys.

RetrieveConnectorRowOptions

Pavadinimas / vardas ir pavardė	Tipas	Aprašas
select	string[]	(Rekomenduojama) Nuskaitomų stulpelių pavadinimų masyvas. Jei nenurodyta, projekcijos nesiunčiamos $select – jungtis nustato, kuriuos stulpelius grąžinti, ir negarantuoja, kad bus grąžinti visi eilutės stulpeliai.

Grąžinimai

Pažadas, kuriame yra eilutės duomenys.

retrieveConnectorRow pavyzdys

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 metodas

Nurodytoje jungčių lentelėje sukuria naują eilutę.

Parametrai

Nustatykite šių būtinų parametrų reikšmes.

Pavadinimas / vardas ir pavardė	Tipas	Aprašas
connectorLogicalName	string	Loginis ryšio nuorodos, susietos su puslapiu, pavadinimas.
dataset	string	Duomenų rinkinys, kuriame yra lentelė.
tableName	string	Lentelės vidinis pavadinimas iš name ypatybės, kurią listConnectorTablesgrąžino . Nenaudokite rodomo vardo.
row	object	Kuriami eilutės duomenys.

Grąžinimai

Pažadas, kuriame yra jungties grąžintas atsakymo tekstas, jei toks yra. Atsižvelgiant į jungtį, ši reikšmė gali būti sukurta eilutė, dalinė eilutė arba be jokios reikšmės.

createConnectorRow pavyzdys

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 metodas

Atnaujina esamą eilutę nurodytoje jungčių lentelėje.

Parametrai

Nustatykite šių būtinų parametrų reikšmes.

Pavadinimas / vardas ir pavardė	Tipas	Aprašas
connectorLogicalName	string	Loginis ryšio nuorodos, susietos su puslapiu, pavadinimas.
dataset	string	Duomenų rinkinys, kuriame yra lentelė.
tableName	string	Lentelės vidinis pavadinimas iš name ypatybės, kurią listConnectorTablesgrąžino . Nenaudokite rodomo vardo.
id	string	Naujintinų eilučių ID.
row	object	Atnaujintinus eilutės duomenis.

Grąžinimai

Pažadas, kuriame yra jungties grąžintas atsakymo tekstas, jei toks yra. Atsižvelgiant į jungtį, ši reikšmė gali būti atnaujinta eilutė, dalinė eilutė arba be reikšmės. Norėdami skaityti dabartines eilutės reikšmes, skambinkite retrieveConnectorRow.

updateConnectorRow pavyzdys

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 metodas

Panaikina eilutę iš nurodytos jungties lentelės.

Parametrai

Nustatykite šių būtinų parametrų reikšmes.

Pavadinimas / vardas ir pavardė	Tipas	Aprašas
connectorLogicalName	string	Loginis ryšio nuorodos, susietos su puslapiu, pavadinimas.
dataset	string	Duomenų rinkinys, kuriame yra lentelė.
tableName	string	Lentelės vidinis pavadinimas iš name ypatybės, kurią listConnectorTablesgrąžino . Nenaudokite rodomo vardo.
id	string	Naikintinų eilučių ID.

Grąžinimai

Pažadas, kuriame pateikiamas operacijos rezultatas. Kai operacija pavyksta, ji nepateikia jokios reikšmės.

deleteConnectorRow pavyzdys

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 metodas

Iškviečia įvardytąją operaciją, kurią veikia REST (operacijos klavišo) jungtis, pvz., HTTP, "Teams" siuntimo pranešimas arba „Office 365“ vartotojai. Lentelės formos jungtys turėtų naudoti užklausos ir eilutės CRUD metodus.

Parametrai

Nustatykite šių būtinų parametrų reikšmes.

Pavadinimas / vardas ir pavardė	Tipas	Aprašas
connectorLogicalName	string	Loginis ryšio nuorodos, susietos su puslapiu, pavadinimas.
operationName	string	Operacijos ID, kaip apibrėžta jungties "Swagger" apibrėžime.
parameters	object	Parametrai, kurių reikia operacijai. Perduoti tuščią objektą ({}), jei operacija nenaudoja parametrų – šis parametras būtinas net tada, kai nieko siųsti nereikia.

Grąžinimai

Pažadas, kuriame yra operacijos rezultatas su šiomis ypatybėmis. Pažadas atmetamas, jei nepavyksta išspręsti ryšio nuorodos, nepavyksta nuskaityti jungties "Swagger" aprašo, joje nerasta operacija, skambutis negali būti išsiųstas arba ryšys nėra įgaliotas (HTTP 403), o vartotojas neužbaigia ryšio sutikimo raginimo.

Pavadinimas / vardas ir pavardė	Tipas	Aprašas
ok	boolean	true kai esama HTTP būsena yra mažesnė nei 400. Ši būsena apima peradresavimo (3xx) būsenas, todėl nelaikysite ok vien tik operacijos grąžintų duomenų įrodymą , taip pat patikrinkite arba patikrinkite statusbody.
status	number	Pirminis HTTP būsenos kodas, kurį pateikė jungtis.
body	unknown	Analizuojamas JSON atsakymo tekstas arba neapdorota eilutė, jei tekstas nėra JSON.

executeConnectorOperation pavyzdys

Toliau pateiktame pavyzdyje daroma prielaida, kad operacija pavadinimu priima CopyFilesourceUrl ir destinationUrl parametrai. Prieš naudodami patikrinkite operacijos ID ir jo parametrus pagal jungties "Swagger" apibrėžimą (pvz., su listConnectorOperations arba getConnectorSwagger), nes galimos operacijos ir jų parametrai skiriasi atsižvelgiant į jungtį.

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