Connectormethoden voor generatieve pagina's

Gebruik de connectormethoden van het dataApi object om te werken met gegevens die worden weergegeven door een Power Platform-connector die is gebonden aan de pagina.

Notitie

Connectormethoden zijn optioneel in het gedeelde dataApi contract. Sommige hosts implementeren ze niet, dus controleer of er een methode bestaat voordat u deze aanroept. Een methode die aanwezig is, betekent niet dat aan de pagina een connector is gekoppeld of dat de verbinding, gegevensset, tabel of bewerking is geconfigureerd, geautoriseerd of toegestaan zoals verwacht.

In tegenstelling tot de actie- en functiemethoden weigeren connectormethoden de geretourneerde belofte wanneer een aanroep mislukt, bijvoorbeeld wanneer de verbindingsreferentie niet kan worden opgelost, de verbinding niet is geautoriseerd en de gebruiker de toestemmingsprompt niet voltooit of de connector een foutstatus retourneert. executeConnectorOperation wordt opgelost met ok: false voor de meeste foutstatussen, maar wordt nog steeds geweigerd voor een ontbrekende bewerking, een niet-geautoriseerde verbinding (403) zonder voltooide toestemming of een transportfout. Wrap connector-aanroepen in try/catch.

Method	Description
createConnectorRow	Hiermee maakt u een nieuwe rij in de opgegeven connectortabel.
deleteConnectorRow	Hiermee verwijdert u een rij uit de opgegeven connectortabel.
executeConnectorOperation	Roept een benoemde bewerking aan die wordt weergegeven door een REST-connector (bewerkingssleutel) zoals Office 365-gebruikers.
getConnectorSwagger	Haalt de Swagger-definitie (OpenAPI) voor de connector op.
getConnectorTableSchema	Hiermee haalt u het schema voor een tabel (ook wel een entiteit of lijst genoemd) op die door de connector wordt weergegeven.
listConnectorDatasets	Geeft een lijst weer van de gegevenssets die beschikbaar zijn voor de connector.
listConnectorOperations	Geeft een lijst weer van de bewerkingen die worden weergegeven door een REST-connector (bewerkingssleutel).
listConnectorTables	Geeft een lijst weer van de tabellen die beschikbaar zijn in de opgegeven connectorgegevensset.
queryConnectorTable	Query's uitvoeren op een tabel die door de connector wordt weergegeven met de opgegeven opties.
retrieveConnectorRow	Haalt één rij op uit de opgegeven connectortabel.
updateConnectorRow	Hiermee wordt een bestaande rij in de opgegeven connectortabel bijgewerkt.

queryConnectorTable methode

Query's uitvoeren op een tabel die door de connector wordt weergegeven met behulp van de opgegeven opties.

Parameters

Stel waarden in voor deze vereiste parameters.

Name	Type	Description
connectorLogicalName	string	De logische naam van de verbindingsreferentie die is gebonden aan de pagina (bijvoorbeeld sp_shared_sharepointonline).
dataset	string	De gegevensset die de tabel bevat, zoals een SharePoint site-URL.
tableName	string	De interne naam van de tabel, van de name eigenschap die wordt geretourneerd door listConnectorTables. Gebruik de weergavenaam niet.
options	QueryConnectorTableOptions	Opties voor het uitvoeren van query's op de tabel.

QueryConnectorTableOptions

Name	Type	Description
select	string[]	(Aanbevolen) Matrix met kolomnamen die moeten worden opgehaald.
filter	string	(Optioneel) Filterexpressie die wordt ondersteund door de connector.
orderBy	string	(Optioneel) Order-by-expressie die wordt ondersteund door de connector.
top	number	(Optioneel) Maximum aantal rijen dat moet worden geretourneerd.

Returns

Een belofte die het resultaat van de bewerking bevat. Wanneer de bewerking is voltooid, retourneert de belofte een object met een gegevenstabel met de resultaten met de volgende eigenschappen:

Name	Type	Description
rows	Object[]	Matrix met rijgegevens.
hasMoreRows	boolean	Geeft aan of er meer rijen beschikbaar zijn.

queryConnectorTable retourneert één pagina met resultaten. Er wordt geen vervolgfunctie geretourneerd en er is momenteel geen ondersteunde manier om de volgende pagina op te halen. Wanneer hasMoreRows is true, komen er meer rijen overeen dan die zijn geretourneerd. Besmal de query met filterof vertel de gebruiker dat de resultaten onvolledig zijn.

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

In de volgende voorbeelden wordt ervan uitgegaan dat documentsTableName de tabel afkomstig is name van listConnectorTables, zoals hierboven wordt weergegeven.

listConnectorTables methode

Geeft een lijst weer van de tabellen (lijsten of entiteiten) die beschikbaar zijn in de opgegeven connectorgegevensset.

Parameters

Stel waarden in voor deze vereiste parameters.

Name	Type	Description
connectorLogicalName	string	De logische naam van de verbindingsreferentie die is gebonden aan de pagina.
dataset	string	De gegevensset waarvoor tabellen moeten worden weergegeven.

Returns

Een belofte met een matrix met tabelgegevens. Elke vermelding heeft de volgende eigenschappen:

Name	Type	Description
name	string	De interne naam van de tabel.
displayName	string	De weergavenaam van de tabel.

voorbeeld listConnectorTables

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

listConnectorDatasets methode

Geeft een lijst weer van de gegevenssets die beschikbaar zijn voor de connector, zoals de SharePoint sites die toegang hebben tot een verbinding.

Parameters

Stel een waarde in voor deze vereiste parameter.

Name	Type	Description
connectorLogicalName	string	De logische naam van de verbindingsreferentie die is gebonden aan de pagina.

Returns

Een belofte met een matrix met gegevenssetgegevens. Elke vermelding heeft de volgende eigenschappen:

Name	Type	Description
name	string	De interne naam of id van de gegevensset.
displayName	string	De weergavenaam van de gegevensset.

voorbeeld listConnectorDatasets

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

listConnectorOperations methode

Geeft een lijst weer van de bewerkingen die zijn gedefinieerd in de Swagger-definitie van de connector, met uitzondering van bewerkingen die zijn gemarkeerd als intern, gesorteerd op weergavenaam. Deze methode is het handigst voor REST-connectors (bewerkingssleutels), zoals Office 365-gebruikers. Voor connectors in tabelvorm gebruikt u de query- en rijmethoden in plaats van de bewerkingen die met deze methode worden vermeld.

Parameters

Stel een waarde in voor deze vereiste parameter.

Name	Type	Description
connectorLogicalName	string	De logische naam van de verbindingsreferentie die is gebonden aan de pagina.

Returns

Een belofte met een matrix met bewerkingsgegevens. Elke vermelding heeft de volgende eigenschappen:

Name	Type	Description
name	string	De bewerkings-id zoals gedefinieerd in de Swagger-definitie van de connector. Geef deze waarde door aan executeConnectorOperation.
displayName	string	De door mensen leesbare bewerkingsnaam voor weergave, zoals de Swagger-samenvatting. Valt terug tot name als er geen samenvatting is gedefinieerd.

voorbeeld listConnectorOperations

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

getConnectorSwagger methode

Haalt de Swagger-definitie (OpenAPI) voor de connector op, waarin de bewerkingen worden beschreven die worden weergegeven. In het geretourneerde document wordt de connector in het algemeen beschreven. Het bevat geen kolomschema's per tabel voor connectors in tabelvorm. Gebruik getConnectorTableSchema deze informatie.

Parameters

Stel een waarde in voor deze vereiste parameter.

Name	Type	Description
connectorApiId	string	De API-id van de connector, zoals /providers/Microsoft.PowerApps/apis/shared_sharepointonline. Deze id verschilt van de logische naam van de verbindingsreferentie (connectorLogicalName) die wordt gebruikt door de meeste andere connectormethoden.

Returns

Een belofte met de Swagger-definitie van de connector als een object.

voorbeeld van 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 methode

Haalt het schema (kolomdefinities) op voor een tabel die door de connector wordt weergegeven. De connector definieert het schema dat wordt geretourneerd en verschilt per connector. Neem niet aan dat deze elke dynamische kolom bevat die een tabel kan bevatten.

Parameters

Stel waarden in voor deze vereiste parameters.

Name	Type	Description
connectorLogicalName	string	De logische naam van de verbindingsreferentie die is gebonden aan de pagina.
dataset	string	De gegevensset die de tabel bevat.
tableName	string	De interne naam van de tabel, van de name eigenschap die wordt geretourneerd door listConnectorTables. Gebruik de weergavenaam niet.

Returns

Een belofte met het schema van de tabel als een object.

voorbeeld 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 methode

Haalt één rij op uit de opgegeven connectortabel.

Parameters

Stel waarden in voor deze vereiste parameters.

Name	Type	Description
connectorLogicalName	string	De logische naam van de verbindingsreferentie die is gebonden aan de pagina.
dataset	string	De gegevensset die de tabel bevat.
tableName	string	De interne naam van de tabel, van de name eigenschap die wordt geretourneerd door listConnectorTables. Gebruik de weergavenaam niet.
id	string	De id van de rij die moet worden opgehaald.
options	RetrieveConnectorRowOptions	(Optioneel) Opties voor het ophalen van de rij.

RetrieveConnectorRowOptions

Name	Type	Description
select	string[]	(Aanbevolen) Matrix met kolomnamen die moeten worden opgehaald. Als u dit weglaat, wordt er geen $select projectie verzonden. De connector bepaalt welke kolommen moeten worden geretourneerd en garandeert niet dat elke kolom in de rij wordt geretourneerd.

Returns

Een belofte met de rijgegevens.

voorbeeld 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 methode

Hiermee maakt u een nieuwe rij in de opgegeven connectortabel.

Parameters

Stel waarden in voor deze vereiste parameters.

Name	Type	Description
connectorLogicalName	string	De logische naam van de verbindingsreferentie die is gebonden aan de pagina.
dataset	string	De gegevensset die de tabel bevat.
tableName	string	De interne naam van de tabel, van de name eigenschap die wordt geretourneerd door listConnectorTables. Gebruik de weergavenaam niet.
row	object	De rijgegevens die moeten worden gemaakt.

Returns

Een belofte die de antwoordtekst bevat die wordt geretourneerd door de connector, indien van toepassing. Afhankelijk van de connector kan deze waarde de gemaakte rij, een gedeeltelijke rij of geen waarde zijn.

voorbeeld 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 methode

Hiermee wordt een bestaande rij in de opgegeven connectortabel bijgewerkt.

Parameters

Stel waarden in voor deze vereiste parameters.

Name	Type	Description
connectorLogicalName	string	De logische naam van de verbindingsreferentie die is gebonden aan de pagina.
dataset	string	De gegevensset die de tabel bevat.
tableName	string	De interne naam van de tabel, van de name eigenschap die wordt geretourneerd door listConnectorTables. Gebruik de weergavenaam niet.
id	string	De id van de rij die moet worden bijgewerkt.
row	object	De rijgegevens die moeten worden bijgewerkt.

Returns

Een belofte die de antwoordtekst bevat die wordt geretourneerd door de connector, indien van toepassing. Afhankelijk van de connector kan deze waarde de bijgewerkte rij, een gedeeltelijke rij of geen waarde zijn. Als u de huidige waarden van de rij wilt lezen, roept u het aan retrieveConnectorRow.

voorbeeld 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 methode

Hiermee verwijdert u een rij uit de opgegeven connectortabel.

Parameters

Stel waarden in voor deze vereiste parameters.

Name	Type	Description
connectorLogicalName	string	De logische naam van de verbindingsreferentie die is gebonden aan de pagina.
dataset	string	De gegevensset die de tabel bevat.
tableName	string	De interne naam van de tabel, van de name eigenschap die wordt geretourneerd door listConnectorTables. Gebruik de weergavenaam niet.
id	string	De id van de rij die u wilt verwijderen.

Returns

Een belofte die het resultaat van de bewerking bevat. Wanneer de bewerking is voltooid, wordt er geen waarde geretourneerd.

voorbeeld 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 methode

Roept een benoemde bewerking aan die beschikbaar wordt gemaakt door een REST-connector (bewerkingssleutel), zoals HTTP, Teams send-message of Office 365-gebruikers. Connectors in tabelvorm moeten in plaats daarvan de CRUD-methoden voor query's en rijen gebruiken.

Parameters

Stel waarden in voor deze vereiste parameters.

Name	Type	Description
connectorLogicalName	string	De logische naam van de verbindingsreferentie die is gebonden aan de pagina.
operationName	string	De bewerkings-id zoals gedefinieerd in de Swagger-definitie van de connector.
parameters	object	De parameters die vereist zijn voor de bewerking. Geef een leeg object door ({}) als de bewerking geen parameters accepteert. Deze parameter is zelfs vereist wanneer er niets te verzenden is.

Returns

Een belofte met het bewerkingsresultaat met deze eigenschappen. De belofte weigert als de verbindingsreferentie niet kan worden opgelost, de Swagger-definitie van de connector kan niet worden opgehaald, de bewerking wordt niet gevonden, de aanroep kan niet worden verzonden of de verbinding is niet geautoriseerd (HTTP 403) en de gebruiker voltooit de verbindingstoestemmingsprompt niet.

Name	Type	Description
ok	boolean	true wanneer de onderliggende HTTP-status kleiner is dan 400. Deze status omvat omleidingsstatussen (3xx), dus behandel ok niet alleen als bewijs van de geretourneerde gegevens , ook controleren status of inspecteren body.
status	number	De onbewerkte HTTP-statuscode die door de connector wordt geretourneerd.
body	unknown	De geparseerde hoofdtekst van het JSON-antwoord of de onbewerkte tekenreeks als de hoofdtekst geen JSON is.

voorbeeld executeConnectorOperation

In het volgende voorbeeld wordt ervan uitgegaan dat een bewerking met de naam CopyFile accepteert en destinationUrl parameters accepteertsourceUrl. Controleer de bewerkings-id en de bijbehorende parameters op basis van de eigen Swagger-definitie van de connector (bijvoorbeeld met listConnectorOperations of getConnectorSwagger) voordat u deze gebruikt, omdat de beschikbare bewerkingen en de bijbehorende parameters per connector verschillen.

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