Liitinmenetelmät luoville sivuille

Objektin liitinmenetelmien dataApi avulla voit käsitellä sivulle sidotun Power Platform -liittimen paljastamia tietoja.

Note

Liitinmenetelmät ovat valinnaisia jaetussa dataApi sopimuksessa. Jotkin isännät eivät ota niitä käyttöön, joten tarkista menetelmän olemassaolo ennen sen kutsumista. Menetelmä ei tarkoita, että sivulla on siihen sidottu liitin tai että yhteys, tietojoukko, taulukko tai toiminto on määritetty, valtuutettu tai sallittu odotetulla tavalla.

Toisin kuin toiminto- ja funktiomenetelmissä liitinmenetelmät hylkäävät palautetun lupauksen, kun kutsu epäonnistuu . Esimerkiksi kun yhteysviittausta ei voida ratkaista, yhteys ei ole valtuutettu ja käyttäjä ei täytä suostumuskehotetta tai liitin palauttaa virheen tilan. executeConnectorOperation korjaa ok: false useimmissa virhetilanteissa, mutta silti hylkää puuttuvan toiminnon, luvattoman yhteyden (403) ilman suostumusta tai kuljetusvirheen. Rivitä liitinkutsut kohteessa try/catch.

Menetelmä	Kuvaus
createConnectorRow	Luo uuden rivin määritettyyn liitintaulukkoon.
deleteConnectorRow	Poistaa rivin määritetystä liitintaulukosta.
executeConnectorOperation	Käynnistää nimetyn toiminnon, jonka REST-liitin (toimintoavain) paljastaa, kuten Office 365 -käyttäjät.
getConnectorSwagger	Hakee liittimen Swagger (OpenAPI) -määrityksen.
getConnectorTableSchema	Noutaa liittimen paljastaman taulukon (kutsutaan myös entiteetiksi tai luetteloksi) rakenteen.
listConnectorDatasets	Näyttää luettelon liittimen käytettävissä olevista tietojoukoista.
listConnectorOperations	Näyttää luettelon REST (toimintoavain) -liittimen paljastamista toiminnoista.
listConnectorTables	Näyttää luettelon määritetyn liittimen tietojoukon käytettävissä olevista taulukoista.
queryConnectorTable	Tekee kyselyn liittimen paljastamaan taulukkoon määritetyillä asetuksilla.
retrieveConnectorRow	Hakee yksittäisen rivin määritetystä liitintaulukosta.
updateConnectorRow	Päivittää määritetyn liitintaulukon olemassa olevan rivin.

queryConnectorTable menetelmä

Tekee kyselyn liittimen paljastamalle taulukolle käyttämällä määritettyjä asetuksia.

Parametrit

Määritä näiden pakollisten parametrien arvot.

Nimi	Kirjoita	Kuvaus
connectorLogicalName	string	Sivulle sidotun yhteysviittauksen looginen nimi (esimerkiksi sp_shared_sharepointonline).
dataset	string	Taulukon sisältävä tietojoukko, kuten SharePoint sivuston URL-osoite.
tableName	string	Taulukon sisäinen nimi kohteen palauttamasta listConnectorTablesominaisuudestaname. Älä käytä näyttönimeä.
options	QueryConnectorTableOptions	Kyselyn vaihtoehdot taulukolle.

QueryConnectorTableOptions

Nimi	Kirjoita	Kuvaus
select	string[]	(Suositus) Noudettava sarakenimien matriisi.
filter	string	(Valinnainen) Suodatinlauseke, jota liitin tukee.
orderBy	string	(Valinnainen) Liittimen tukema Order-by-lauseke.
top	number	(Valinnainen) Palautettavien rivien enimmäismäärä.

Palautukset

Lupaus, joka sisältää operaation tuloksen. Kun toiminto onnistuu, lupaus palauttaa objektin, joka sisältää tietotaulukon, joka sisältää tulokset seuraavilla ominaisuuksilla:

Nimi	Kirjoita	Kuvaus
rows	Object[]	Rivitietojen matriisi.
hasMoreRows	boolean	Ilmaisee, onko enemmän rivejä käytettävissä.

queryConnectorTable palauttaa yhden tulossivun. Se ei palauta jatkumisfunktiota, eikä seuraavan sivun noutamista tällä hetkellä tueta. Kun hasMoreRows arvo on true, täsmäytettiin enemmän rivejä kuin palautettiin. Rajoita kyselyä :n avulla filtertai kerro käyttäjälle, että tulokset ovat epätäydelliset.

esimerkki queryConnectorTable-taulukosta

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

Seuraavissa esimerkeissä oletetaan, että documentsTableName taulukon name tiedot ovat peräisin listConnectorTableskohteesta , kuten yllä on esitetty.

listConnectorTables menetelmä

Näyttää luettelon määritetyn liittimen tietojoukon käytettävissä olevista taulukoista (luetteloista tai entiteeteistä).

Parametrit

Määritä näiden pakollisten parametrien arvot.

Nimi	Kirjoita	Kuvaus
connectorLogicalName	string	Sivulle sidotun yhteysviittauksen looginen nimi.
dataset	string	Tietojoukko, jonka taulukoiden luettelointi on.

Palautukset

Lupaus, joka sisältää taulukkotietoja. Jokaisella merkinnällä on seuraavat ominaisuudet:

Nimi	Kirjoita	Kuvaus
name	string	Taulukon sisäinen nimi.
displayName	string	Taulukon näyttönimi.

listConnectorTables-esimerkki

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

listConnectorDatasets menetelmä

Näyttää luettelon liittimelle käytettävissä olevista tietojoukoista, kuten SharePoint sivustoista, joihin yhteydellä on käyttöoikeus.

Parametrit

Määritä tälle pakolliselle parametrille arvo.

Nimi	Kirjoita	Kuvaus
connectorLogicalName	string	Sivulle sidotun yhteysviittauksen looginen nimi.

Palautukset

Lupaus, joka sisältää matriisin tietojoukon tietoja. Jokaisella merkinnällä on seuraavat ominaisuudet:

Nimi	Kirjoita	Kuvaus
name	string	Tietojoukon sisäinen nimi tai tunniste.
displayName	string	Tietojoukon näyttönimi.

listConnectorDatasets-esimerkki

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

listConnectorOperations menetelmä

Näyttää luettelon liittimen Swagger-määritelmässä määritetyistä toiminnoista, lukuun ottamatta sisäisiksi merkittyjä toimintoja, näyttönimen mukaan lajiteltuja toimintoja. Tästä menetelmästä on eniten hyötyä REST (toimintoavain) -liittimille, kuten Office 365 -käyttäjät. Taulukkomuotoisissa liittimissä voit käyttää kysely- ja rivimenetelmiä tämän menetelmän luetteloimien toimintojen sijaan.

Parametrit

Määritä tälle pakolliselle parametrille arvo.

Nimi	Kirjoita	Kuvaus
connectorLogicalName	string	Sivulle sidotun yhteysviittauksen looginen nimi.

Palautukset

Lupaus, joka sisältää matriisin toimintatietoja. Jokaisella merkinnällä on seuraavat ominaisuudet:

Nimi	Kirjoita	Kuvaus
name	string	Tämä on toimintotunnus, joka on määritetty liittimen Swagger-määrityksessä. Siirrä tämä arvo kohteeseen executeConnectorOperation.
displayName	string	Ihmisen luettavissa oleva näytettävä operaation nimi, kuten Swagger-yhteenveto. Palauttaa arvon , jos yhteenvetoa name ei ole määritetty.

listConnectorOperations-esimerkki

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

getConnectorSwagger menetelmä

Noutaa liittimen Swagger (OpenAPI) -määrityksen, jossa kuvataan sen paljastamia toimintoja. Palautettu asiakirja kuvaa liittimen yleistä kuvaa. Se ei sisällä taulukkokohtaisia sarakerakenteita taulukkoyhdistimille. Käytä getConnectorTableSchema näitä tietoja varten.

Parametrit

Määritä tälle pakolliselle parametrille arvo.

Nimi	Kirjoita	Kuvaus
connectorApiId	string	Liittimen ohjelmointirajapinnan tunniste, kuten /providers/Microsoft.PowerApps/apis/shared_sharepointonline. Tämä tunniste eroaa yhteyden viittauksen loogisesta nimestä (connectorLogicalName), jota useimmat muut liitinmenetelmät käyttävät.

Palautukset

Lupaus, joka sisältää liittimen Swagger-määritelmän objektina.

getConnectorSwagger esimerkki

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 menetelmä

Hakee liittimen käyttöön antaman taulukon rakenteen (sarakemääritykset). Liitin määrittää rakenteen, jonka se palauttaa, ja se vaihtelee liittimen mukaan. Älä oleta, että se sisältää kaikki taulukon mahdollisesti sisältämät dynaamiset sarakkeet.

Parametrit

Määritä näiden pakollisten parametrien arvot.

Nimi	Kirjoita	Kuvaus
connectorLogicalName	string	Sivulle sidotun yhteysviittauksen looginen nimi.
dataset	string	Taulukon sisältävä tietojoukko.
tableName	string	Taulukon sisäinen nimi kohteen palauttamasta listConnectorTablesominaisuudestaname. Älä käytä näyttönimeä.

Palautukset

Lupaus, joka sisältää taulukon rakenteen objektina.

esimerkki getConnectorTableSchemasta

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 menetelmä

Hakee yksittäisen rivin määritetystä liitintaulukosta.

Parametrit

Määritä näiden pakollisten parametrien arvot.

Nimi	Kirjoita	Kuvaus
connectorLogicalName	string	Sivulle sidotun yhteysviittauksen looginen nimi.
dataset	string	Taulukon sisältävä tietojoukko.
tableName	string	Taulukon sisäinen nimi kohteen palauttamasta listConnectorTablesominaisuudestaname. Älä käytä näyttönimeä.
id	string	Noudettavan rivin tunnus.
options	HaeConnectorRowOptions	(Valinnainen) Vaihtoehdot rivin noutamiseen.

HaeConnectorRowOptions

Nimi	Kirjoita	Kuvaus
select	string[]	(Suositus) Noudettava sarakenimien matriisi. Jos tämä jätetään pois, projektiota ei $select lähetetä – liitin määrittää, mitkä sarakkeet palautetaan, eikä takaa rivin jokaisen sarakkeen palauttamista.

Palautukset

Lupaus, joka sisältää rivitiedot.

esimerkki 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 menetelmä

Luo uuden rivin määritettyyn liitintaulukkoon.

Parametrit

Määritä näiden pakollisten parametrien arvot.

Nimi	Kirjoita	Kuvaus
connectorLogicalName	string	Sivulle sidotun yhteysviittauksen looginen nimi.
dataset	string	Taulukon sisältävä tietojoukko.
tableName	string	Taulukon sisäinen nimi kohteen palauttamasta listConnectorTablesominaisuudestaname. Älä käytä näyttönimeä.
row	object	Luotavat rivitiedot.

Palautukset

Lupaus, joka sisältää liittimen palauttaman vastausrungon. Liittimestä riippuen tämä arvo voi olla luotu rivi, osittainen rivi tai ei arvoa.

esimerkki 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 menetelmä

Päivittää määritetyn liitintaulukon olemassa olevan rivin.

Parametrit

Määritä näiden pakollisten parametrien arvot.

Nimi	Kirjoita	Kuvaus
connectorLogicalName	string	Sivulle sidotun yhteysviittauksen looginen nimi.
dataset	string	Taulukon sisältävä tietojoukko.
tableName	string	Taulukon sisäinen nimi kohteen palauttamasta listConnectorTablesominaisuudestaname. Älä käytä näyttönimeä.
id	string	Päivitettävän rivin tunnus.
row	object	Päivitettävät rivitiedot.

Palautukset

Lupaus, joka sisältää liittimen palauttaman vastausrungon. Liittimestä riippuen tämä arvo voi olla päivitetty rivi, osittainen rivi tai ei arvoa. Jos haluat lukea rivin nykyiset arvot, kutsu .retrieveConnectorRow

esimerkki 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 menetelmä

Poistaa rivin määritetystä liitintaulukosta.

Parametrit

Määritä näiden pakollisten parametrien arvot.

Nimi	Kirjoita	Kuvaus
connectorLogicalName	string	Sivulle sidotun yhteysviittauksen looginen nimi.
dataset	string	Taulukon sisältävä tietojoukko.
tableName	string	Taulukon sisäinen nimi kohteen palauttamasta listConnectorTablesominaisuudestaname. Älä käytä näyttönimeä.
id	string	Poistettavan rivin tunnus.

Palautukset

Lupaus, joka sisältää operaation tuloksen. Kun toiminto onnistuu, se ei palauta arvoa.

esimerkki 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 menetelmä

Käynnistää nimetyn toiminnon, jonka REST-liitin (toimintoavain) paljastaa, kuten HTTP, Teamsin lähetysviesti tai Office 365 -käyttäjät. Taulukkomuotoisten liittimien tulee käyttää sen sijaan kysely- ja rivin CRUD-menetelmiä.

Parametrit

Määritä näiden pakollisten parametrien arvot.

Nimi	Kirjoita	Kuvaus
connectorLogicalName	string	Sivulle sidotun yhteysviittauksen looginen nimi.
operationName	string	Tämä on toimintotunnus, joka on määritetty liittimen Swagger-määrityksessä.
parameters	object	Toiminnon edellyttämät parametrit. Välitä tyhjä objekti ({}), jos toiminto ei vie parametreja – tätä parametria tarvitaan, vaikka lähetettävää ei olisikaan.

Palautukset

Lupaus, joka sisältää toiminnon tuloksen näillä ominaisuuksilla. Lupaus hylkää, jos yhteysviittausta ei voida ratkaista, liittimen Swagger-määritystä ei voi hakea, toimintoa ei löydy siitä, kutsua ei voi lähettää tai yhteyttä ei ole sallittu (HTTP 403) ja käyttäjä ei täytä yhteyden suostumuskehotetta.

Nimi	Kirjoita	Kuvaus
ok	boolean	true kun taustalla oleva HTTP-tila on pienempi kuin 400. Tämä tila sisältää uudelleenohjauksen (3xx) tilat, joten älä käsittele ok niitä pelkästään todisteina palautetusta toiminnosta . Tarkista status myös tai tarkasta body.
status	number	Liittimen palauttama HTTP-raakakoodi.
body	unknown	Jäsenntty JSON-vastauksen leipäteksti tai raakamerkkijono, jos runko ei ole JSON.

esimerkki executeConnectorOperation-toiminnosta

Seuraavassa esimerkissä oletetaan toiminto nimeltä CopyFile , joka hyväksyy sourceUrl ja destinationUrl parametreja. Tarkista toimintotunnus ja sen parametrit suhteessa liittimen omaan Swagger-määritelmään (esimerkiksi käyttäen listConnectorOperations tai getConnectorSwagger) ennen sen käyttöä, koska käytettävissä olevat toiminnot ja niiden parametrit vaihtelevat liittimen mukaan.

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