Merk
Tilgang til denne siden krever autorisasjon. Du kan prøve å logge på eller endre kataloger.
Tilgang til denne siden krever autorisasjon. Du kan prøve å endre kataloger.
Bruk koblingsmetodene dataApi for objektet til å arbeide med data som vises av en Power Platform-kobling som er bundet til siden.
Note
Koblingsmetoder er valgfrie i den delte dataApi kontrakten. Enkelte verter implementerer dem ikke, så kontroller at det finnes en metode før du kaller den. En metode som finnes betyr ikke at siden har en kobling bundet til den, eller at tilkoblingen, datasettet, tabellen eller operasjonen er konfigurert, autorisert eller tillatt som forventet.
I motsetning til handlings- og funksjonsmetodene avviser koblingsmetoder det returnerte løftet når et anrop mislykkes, for eksempel når tilkoblingsreferansen ikke kan løses, er ikke tilkoblingen autorisert, og brukeren fullfører ikke samtykkeledeteksten, eller koblingen returnerer en feilstatus.
executeConnectorOperation løses med ok: false for de fleste feilstatuser, men avviser fremdeles en manglende operasjon, en uautorisert tilkobling (403) uten fullført samtykke eller en transportfeil. Bryt koblingskall i try/catch.
| Metode | Description |
|---|---|
createConnectorRow |
Oppretter en ny rad i den angitte koblingstabellen. |
deleteConnectorRow |
Sletter en rad fra den angitte koblingstabellen. |
executeConnectorOperation |
Aktiverer en navngitt operasjon som vises av en REST-kobling (operasjonstavet), for eksempel Office 365-brukere. |
getConnectorSwagger |
Henter Swagger-definisjonen (OpenAPI) for koblingen. |
getConnectorTableSchema |
Henter skjemaet for en tabell (også kalt en enhet eller liste) som vises av koblingen. |
listConnectorDatasets |
Viser datasettene som er tilgjengelige for koblingen. |
listConnectorOperations |
Viser operasjonene som vises av en REST-kobling (operasjonstavet). |
listConnectorTables |
Viser tabellene som er tilgjengelige i det angitte koblingsdatasettet. |
queryConnectorTable |
Spør en tabell som vises av koblingen med de angitte alternativene. |
retrieveConnectorRow |
Henter én rad fra den angitte koblingstabellen. |
updateConnectorRow |
Oppdaterer en eksisterende rad i den angitte koblingstabellen. |
queryConnectorTable metode
Spør en tabell som vises av koblingen ved hjelp av de angitte alternativene.
Parametre
Angi verdier for disse nødvendige parameterne.
| Navn | Type | Description |
|---|---|---|
connectorLogicalName |
string |
Det logiske navnet på tilkoblingsreferansen som er bundet til siden (for eksempel sp_shared_sharepointonline). |
dataset |
string |
Datasettet som inneholder tabellen, for eksempel en url-adresse for SharePoint nettsted. |
tableName |
string |
Tabellens interne navn, fra name egenskapen som returneres av listConnectorTables. Ikke bruk visningsnavnet. |
options |
QueryConnectorTableOptions | Alternativer for spørring av tabellen. |
QueryConnectorTableOptions
| Navn | Type | Description |
|---|---|---|
select |
string[] |
(Anbefales) Matrise med kolonnenavn som skal hentes. |
filter |
string |
(Valgfritt) Filteruttrykk som støttes av koblingen. |
orderBy |
string |
(Valgfritt) Order-by-uttrykk som støttes av koblingen. |
top |
number |
(Valgfritt) Maksimalt antall rader som skal returneres. |
Returer
Et løfte som inneholder resultatet av operasjonen. Når operasjonen lykkes, returnerer løftet et objekt som inneholder en datatabell med resultatene med disse egenskapene:
| Navn | Type | Description |
|---|---|---|
rows |
Object[] |
Matrise med raddata. |
hasMoreRows |
boolean |
Angir om det er flere rader tilgjengelig. |
queryConnectorTable returnerer én enkelt side med resultater. Den returnerer ikke en fortsettelsesfunksjon, og det finnes for øyeblikket ingen støttede måter å hente neste side på. Når hasMoreRows er truedet, samsvarer flere rader enn det som ble returnert. Begrens spørringen med filter, eller fortell brukeren at resultatene er ufullstendige.
eksempel på 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,
}
);
Eksemplene nedenfor forutsetter at documentsTableName tabellen er name fra listConnectorTables, som vist ovenfor.
listConnectorTables metode
Viser tabellene (lister eller enheter) som er tilgjengelige i det angitte koblingsdatasettet.
Parametre
Angi verdier for disse nødvendige parameterne.
| Navn | Type | Description |
|---|---|---|
connectorLogicalName |
string |
Det logiske navnet på tilkoblingsreferansen som er bundet til siden. |
dataset |
string |
Datasettet du vil vise tabeller for. |
Returer
Et løfte som inneholder en matrise med tabellinformasjon. Hver oppføring har disse egenskapene:
| Navn | Type | Description |
|---|---|---|
name |
string |
Det interne navnet på tabellen. |
displayName |
string |
Visningsnavnet for tabellen. |
eksempel på listConnectorTables
const tables = await dataApi.listConnectorTables?.(
"sp_shared_sharepointonline",
"https://contoso.sharepoint.com/sites/Marketing"
);
listConnectorDatasets metode
Viser datasettene som er tilgjengelige for koblingen, for eksempel de SharePoint områdene en tilkobling har tilgang til.
Parametre
Angi en verdi for denne nødvendige parameteren.
| Navn | Type | Description |
|---|---|---|
connectorLogicalName |
string |
Det logiske navnet på tilkoblingsreferansen som er bundet til siden. |
Returer
Et løfte som inneholder en matrise med datasettinformasjon. Hver oppføring har disse egenskapene:
| Navn | Type | Description |
|---|---|---|
name |
string |
Det interne navnet eller identifikatoren for datasettet. |
displayName |
string |
Visningsnavnet for datasettet. |
eksempel på listConnectorDatasets
const datasets = await dataApi.listConnectorDatasets?.("sp_shared_sharepointonline");
listConnectorOperations metode
Viser operasjonene som er definert i koblingens Swagger-definisjon, unntatt operasjoner merket som interne, sortert etter visningsnavn. Denne metoden er mest nyttig for REST-koblinger (operasjonstaster), for eksempel Office 365-brukere. For tabellkoblinger bruker du spørrings- og radmetodene i stedet for operasjonene denne metoden viser.
Parametre
Angi en verdi for denne nødvendige parameteren.
| Navn | Type | Description |
|---|---|---|
connectorLogicalName |
string |
Det logiske navnet på tilkoblingsreferansen som er bundet til siden. |
Returer
Et løfte som inneholder en matrise med operasjonsinformasjon. Hver oppføring har disse egenskapene:
| Navn | Type | Description |
|---|---|---|
name |
string |
Operasjons-ID-en som er definert i koblingens Swagger-definisjon. Send denne verdien til executeConnectorOperation. |
displayName |
string |
Det menneskelesbare operasjonsnavnet for visning, for eksempel Swagger-sammendraget. Faller tilbake til name hvis ingen sammendrag er definert. |
eksempel på listConnectorOperations
const operations = await dataApi.listConnectorOperations?.("sp_shared_sharepointonline");
getConnectorSwagger metode
Henter Swagger-definisjonen (OpenAPI) for koblingen, som beskriver operasjonene den viser. Det returnerte dokumentet beskriver koblingen generelt. Det inkluderer ikke kolonneskjemaer per tabell for tabellkoblinger. Bruk getConnectorTableSchema denne informasjonen.
Parametre
Angi en verdi for denne nødvendige parameteren.
| Navn | Type | Description |
|---|---|---|
connectorApiId |
string |
Tilkoblings-API-identifikatoren, for eksempel /providers/Microsoft.PowerApps/apis/shared_sharepointonline. Denne identifikatoren er forskjellig fra det logiske navnet på tilkoblingsreferansen (connectorLogicalName) som brukes av de fleste andre koblingsmetoder. |
Returer
Et løfte som inneholder koblingens Swagger-definisjon som et objekt.
getConnectorSwagger-eksempel
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 metode
Henter skjemaet (kolonnedefinisjonene) for en tabell som vises av koblingen. Koblingen definerer skjemaet den returnerer, og det varierer etter kobling. Ikke anta at den inneholder alle dynamiske kolonner en tabell kan inneholde.
Parametre
Angi verdier for disse nødvendige parameterne.
| Navn | Type | Description |
|---|---|---|
connectorLogicalName |
string |
Det logiske navnet på tilkoblingsreferansen som er bundet til siden. |
dataset |
string |
Datasettet som inneholder tabellen. |
tableName |
string |
Tabellens interne navn, fra name egenskapen som returneres av listConnectorTables. Ikke bruk visningsnavnet. |
Returer
Et løfte som inneholder tabellens skjema som et objekt.
getConnectorTableSchema-eksempel
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 metode
Henter én rad fra den angitte koblingstabellen.
Parametre
Angi verdier for disse nødvendige parameterne.
| Navn | Type | Description |
|---|---|---|
connectorLogicalName |
string |
Det logiske navnet på tilkoblingsreferansen som er bundet til siden. |
dataset |
string |
Datasettet som inneholder tabellen. |
tableName |
string |
Tabellens interne navn, fra name egenskapen som returneres av listConnectorTables. Ikke bruk visningsnavnet. |
id |
string |
ID-en for raden som skal hentes. |
options |
HentConnectorRowOptions | (Valgfritt) Alternativer for å hente raden. |
HentConnectorRowOptions
| Navn | Type | Description |
|---|---|---|
select |
string[] |
(Anbefales) Matrise med kolonnenavn som skal hentes. Hvis den utelates, sendes ingen $select projeksjon – koblingen bestemmer hvilke kolonner som skal returneres, og garanterer ikke å returnere hver kolonne i raden. |
Returer
Et løfte som inneholder raddataene.
hentConnectorRow-eksempel
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 metode
Oppretter en ny rad i den angitte koblingstabellen.
Parametre
Angi verdier for disse nødvendige parameterne.
| Navn | Type | Description |
|---|---|---|
connectorLogicalName |
string |
Det logiske navnet på tilkoblingsreferansen som er bundet til siden. |
dataset |
string |
Datasettet som inneholder tabellen. |
tableName |
string |
Tabellens interne navn, fra name egenskapen som returneres av listConnectorTables. Ikke bruk visningsnavnet. |
row |
object |
Raddataene som skal opprettes. |
Returer
Et løfte som inneholder svarteksten som returneres av koblingen, om noen. Avhengig av koblingen kan denne verdien være den opprettede raden, en delvis rad eller ingen verdi.
createConnectorRow-eksempel
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 metode
Oppdaterer en eksisterende rad i den angitte koblingstabellen.
Parametre
Angi verdier for disse nødvendige parameterne.
| Navn | Type | Description |
|---|---|---|
connectorLogicalName |
string |
Det logiske navnet på tilkoblingsreferansen som er bundet til siden. |
dataset |
string |
Datasettet som inneholder tabellen. |
tableName |
string |
Tabellens interne navn, fra name egenskapen som returneres av listConnectorTables. Ikke bruk visningsnavnet. |
id |
string |
ID-en for raden som skal oppdateres. |
row |
object |
Raddataene som skal oppdateres. |
Returer
Et løfte som inneholder svarteksten som returneres av koblingen, om noen. Avhengig av koblingen kan denne verdien være den oppdaterte raden, en delvis rad eller ingen verdi. Hvis du vil lese gjeldende verdier for raden, kaller du .retrieveConnectorRow
updateConnectorRow-eksempel
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 metode
Sletter en rad fra den angitte koblingstabellen.
Parametre
Angi verdier for disse nødvendige parameterne.
| Navn | Type | Description |
|---|---|---|
connectorLogicalName |
string |
Det logiske navnet på tilkoblingsreferansen som er bundet til siden. |
dataset |
string |
Datasettet som inneholder tabellen. |
tableName |
string |
Tabellens interne navn, fra name egenskapen som returneres av listConnectorTables. Ikke bruk visningsnavnet. |
id |
string |
ID-en for raden som skal slettes. |
Returer
Et løfte som inneholder resultatet av operasjonen. Når operasjonen lykkes, returnerer den ingen verdi.
deleteConnectorRow-eksempel
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 metode
Aktiverer en navngitt operasjon som vises av en REST-kobling (operasjonstavet), for eksempel HTTP, Teams-sendingsmelding eller Office 365-brukere. Tabellkoblinger bør bruke spørrings- og rad-CRUD-metodene i stedet.
Parametre
Angi verdier for disse nødvendige parameterne.
| Navn | Type | Description |
|---|---|---|
connectorLogicalName |
string |
Det logiske navnet på tilkoblingsreferansen som er bundet til siden. |
operationName |
string |
Operasjons-ID-en som er definert i koblingens Swagger-definisjon. |
parameters |
object |
Parameterne som kreves av operasjonen. Send et tomt objekt ({}) hvis operasjonen ikke tar noen parametere – denne parameteren er nødvendig selv når det ikke er noe å sende. |
Returer
Et løfte som inneholder operasjonsresultatet med disse egenskapene. Løftet avviser hvis tilkoblingsreferansen ikke kan løses, koblingens Swagger-definisjon kan ikke hentes, operasjonen finnes ikke i den, samtalen kan ikke sendes, eller tilkoblingen er ikke autorisert (HTTP 403) og brukeren fullfører ikke forespørselen om tilkoblingssamtykke.
| Navn | Type | Description |
|---|---|---|
ok |
boolean |
true når den underliggende HTTP-statusen er mindre enn 400. Denne statusen inkluderer omadresseringsstatuser (3xx), så ikke behandle ok alene som bevis på operasjonens returnerte data – kontroller status eller undersøk body. |
status |
number |
Den rå HTTP-statuskoden som returneres av koblingen. |
body |
unknown |
Den analyserte JSON-responskroppen, eller den rå strengen hvis kroppen ikke er JSON. |
executeConnectorOperation-eksempel
Følgende eksempel forutsetter en operasjon med navnet CopyFile godtar sourceUrl og destinationUrl parametere. Bekreft operasjons-ID-en og dens parametere mot koblingens egen Swagger-definisjon (for eksempel med listConnectorOperations eller getConnectorSwagger) før du bruker den, siden tilgjengelige operasjoner og deres parametere varierer etter kobling.
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);
}