Metody łącznika dla stron generowania

Użyj metod łącznika dataApi obiektu, aby pracować z danymi uwidocznianymi przez łącznik platformy Power Platform powiązany ze stroną.

Uwaga / Notatka

Metody łączników są opcjonalne w umowie udostępnionej dataApi . Niektóre hosty nie implementują ich, dlatego przed wywołaniem metody sprawdź, czy istnieje metoda. Obecna metoda nie oznacza, że strona ma powiązany łącznik lub że połączenie, zestaw danych, tabela lub operacja jest konfigurowana, autoryzowana lub dozwolona zgodnie z oczekiwaniami.

W przeciwieństwie do metod akcji i funkcji metody łącznika odrzucają zwróconą obietnicę, gdy wywołanie nie powiedzie się — na przykład gdy nie można rozpoznać odwołania do połączenia, połączenie nie jest autoryzowane, a użytkownik nie ukończy monitu o wyrażenie zgody lub łącznik zwraca stan błędu. executeConnectorOperation program rozwiązuje problem z ok: false dla większości stanów błędów, ale nadal odrzuca brakujących operacji, nieautoryzowanego połączenia (403) bez ukończonej zgody lub awarii transportu. Zawijanie wywołań łącznika w programie try/catch.

Metoda	Description
createConnectorRow	Tworzy nowy wiersz w określonej tabeli łącznika.
deleteConnectorRow	Usuwa wiersz z określonej tabeli łącznika.
executeConnectorOperation	Wywołuje nazwaną operację uwidacznianą przez łącznik REST (klucz operacji), taki jak Użytkownicy usługi Office 365.
getConnectorSwagger	Pobiera definicję struktury Swagger (OpenAPI) dla łącznika.
getConnectorTableSchema	Pobiera schemat tabeli (nazywanej również jednostką lub listą) uwidacznianą przez łącznik.
listConnectorDatasets	Wyświetla listę zestawów danych dostępnych dla łącznika.
listConnectorOperations	Wyświetla listę operacji uwidocznionych przez łącznik REST (klucz operacji).
listConnectorTables	Wyświetla tabele dostępne w określonym zestawie danych łącznika.
queryConnectorTable	Wykonuje zapytania dotyczące tabeli uwidocznionej przez łącznik przy użyciu określonych opcji.
retrieveConnectorRow	Pobiera jeden wiersz z określonej tabeli łącznika.
updateConnectorRow	Aktualizuje istniejący wiersz w określonej tabeli łącznika.

Metoda queryConnectorTable

Wysyła zapytanie do tabeli uwidocznionej przez łącznik przy użyciu określonych opcji.

Parameters

Ustaw wartości dla tych wymaganych parametrów.

Name	Typ	Description
connectorLogicalName	string	Nazwa logiczna odwołania połączenia powiązana ze stroną (na przykład sp_shared_sharepointonline).
dataset	string	Zestaw danych zawierający tabelę, taki jak adres URL witryny SharePoint.
tableName	string	Wewnętrzna nazwa tabeli z name właściwości zwróconej przez listConnectorTables. Nie używaj nazwy wyświetlanej.
options	QueryConnectorTableOptions	Opcje wykonywania zapytań względem tabeli.

QueryConnectorTableOptions

Name	Typ	Description
select	string[]	(Zalecane) Tablica nazw kolumn do pobrania.
filter	string	(Opcjonalnie) Wyrażenie filtru obsługiwane przez łącznik.
orderBy	string	(Opcjonalnie) Wyrażenie Order-by obsługiwane przez łącznik.
top	number	(Opcjonalnie) Maksymalna liczba wierszy do zwrócenia.

Returns

Obietnica zawierająca wynik operacji. Po pomyślnym zakończeniu operacji obietnica zwraca obiekt zawierający tabelę danych z wynikami o następujących właściwościach:

Name	Typ	Description
rows	Object[]	Tablica danych wierszy.
hasMoreRows	boolean	Wskazuje, czy jest dostępnych więcej wierszy.

queryConnectorTable Zwraca jedną stronę wyników. Nie zwraca funkcji kontynuacji i obecnie nie ma obsługiwanego sposobu pobierania następnej strony. Gdy hasMoreRows wartość to true, więcej wierszy dopasowanych niż zostały zwrócone. Zawęź zapytanie za pomocą filterpolecenia lub poinformuj użytkownika, że wyniki są niekompletne.

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

W poniższych przykładach przyjęto założenie, że documentsTableName tabela zawiera tabelę name z listConnectorTables, jak pokazano powyżej.

Metoda listConnectorTables

Wyświetla tabele (listy lub jednostki) dostępne w określonym zestawie danych łącznika.

Parameters

Ustaw wartości dla tych wymaganych parametrów.

Name	Typ	Description
connectorLogicalName	string	Nazwa logiczna odwołania połączenia powiązana ze stroną.
dataset	string	Zestaw danych do wyświetlenia listy tabel.

Returns

Obietnica zawierająca tablicę informacji o tabeli. Każdy wpis ma następujące właściwości:

Name	Typ	Description
name	string	Wewnętrzna nazwa tabeli.
displayName	string	Nazwa wyświetlana tabeli.

przykład listConnectorTables

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

Metoda listConnectorDatasets

Wyświetla listę zestawów danych dostępnych dla łącznika, takich jak lokacje SharePoint, do których może uzyskiwać dostęp połączenie.

Parameters

Ustaw wartość dla tego wymaganego parametru.

Name	Typ	Description
connectorLogicalName	string	Nazwa logiczna odwołania połączenia powiązana ze stroną.

Returns

Obietnica zawierająca tablicę informacji o zestawie danych. Każdy wpis ma następujące właściwości:

Name	Typ	Description
name	string	Wewnętrzna nazwa lub identyfikator zestawu danych.
displayName	string	Nazwa wyświetlana zestawu danych.

przykład listConnectorDatasets

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

Metoda listConnectorOperations

Wyświetla listę operacji zdefiniowanych w definicji struktury Swagger łącznika, z wyłączeniem operacji oznaczonych jako wewnętrzne, posortowane według nazwy wyświetlanej. Ta metoda jest najbardziej przydatna w przypadku łączników REST (kluczem operacji), takich jak Użytkownicy usługi Office 365. W przypadku łączników tabelarycznych użyj metod zapytania i wierszy zamiast operacji, które zawiera ta metoda.

Parameters

Ustaw wartość dla tego wymaganego parametru.

Name	Typ	Description
connectorLogicalName	string	Nazwa logiczna odwołania połączenia powiązana ze stroną.

Returns

Obietnica zawierająca tablicę informacji o operacjach. Każdy wpis ma następujące właściwości:

Name	Typ	Description
name	string	Identyfikator operacji zdefiniowany w definicji struktury Swagger łącznika. Przekaż tę wartość do executeConnectorOperation.
displayName	string	Nazwa operacji czytelnej dla człowieka dla wyświetlania, taka jak podsumowanie struktury Swagger. Wraca do name elementu , jeśli nie zdefiniowano żadnego podsumowania.

przykład listConnectorOperations

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

Metoda getConnectorSwagger

Pobiera definicję struktury Swagger (OpenAPI) dla łącznika, która opisuje ujawniane operacje. Zwrócony dokument opisuje ogólny łącznik. Nie zawiera schematów kolumn dla tabeli dla łączników tabelarycznych. Użyj getConnectorTableSchema tych informacji.

Parameters

Ustaw wartość dla tego wymaganego parametru.

Name	Typ	Description
connectorApiId	string	Identyfikator interfejsu API łącznika, taki jak /providers/Microsoft.PowerApps/apis/shared_sharepointonline. Ten identyfikator różni się od nazwy logicznej odwołania do połączenia (connectorLogicalName) używanej przez większość innych metod łącznika.

Returns

Obietnica zawierająca definicję struktury Swagger łącznika jako obiekt.

przykład 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"
);

Metoda getConnectorTableSchema

Pobiera schemat (definicje kolumn) dla tabeli uwidocznionej przez łącznik. Łącznik definiuje zwracany schemat i różni się w zależności od łącznika. Nie zakładaj, że zawiera każdą kolumnę dynamiczną, która może zawierać tabelę.

Parameters

Ustaw wartości dla tych wymaganych parametrów.

Name	Typ	Description
connectorLogicalName	string	Nazwa logiczna odwołania połączenia powiązana ze stroną.
dataset	string	Zestaw danych zawierający tabelę.
tableName	string	Wewnętrzna nazwa tabeli z name właściwości zwróconej przez listConnectorTables. Nie używaj nazwy wyświetlanej.

Returns

Obietnica zawierająca schemat tabeli jako obiekt.

przykład 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
);

Metoda retrieveConnectorRow

Pobiera jeden wiersz z określonej tabeli łącznika.

Parameters

Ustaw wartości dla tych wymaganych parametrów.

Name	Typ	Description
connectorLogicalName	string	Nazwa logiczna odwołania połączenia powiązana ze stroną.
dataset	string	Zestaw danych zawierający tabelę.
tableName	string	Wewnętrzna nazwa tabeli z name właściwości zwróconej przez listConnectorTables. Nie używaj nazwy wyświetlanej.
id	string	Identyfikator wiersza do pobrania.
options	RetrieveConnectorRowOptions	(Opcjonalnie) Opcje pobierania wiersza.

RetrieveConnectorRowOptions

Name	Typ	Description
select	string[]	(Zalecane) Tablica nazw kolumn do pobrania. Jeśli pominięto, nie $select zostanie wysłana żadna projekcja — łącznik określa, które kolumny mają zostać zwrócone i nie gwarantuje zwrócenia każdej kolumny w wierszu.

Returns

Obietnica zawierająca dane wierszy.

przykład 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"
);

Metoda createConnectorRow

Tworzy nowy wiersz w określonej tabeli łącznika.

Parameters

Ustaw wartości dla tych wymaganych parametrów.

Name	Typ	Description
connectorLogicalName	string	Nazwa logiczna odwołania połączenia powiązana ze stroną.
dataset	string	Zestaw danych zawierający tabelę.
tableName	string	Wewnętrzna nazwa tabeli z name właściwości zwróconej przez listConnectorTables. Nie używaj nazwy wyświetlanej.
row	object	Dane wiersza do utworzenia.

Returns

Obietnica zawierająca treść odpowiedzi zwróconą przez łącznik, jeśli istnieje. W zależności od łącznika ta wartość może być utworzonym wierszem, wierszem częściowym lub bez wartości.

przykład 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" }
);

Metoda updateConnectorRow

Aktualizuje istniejący wiersz w określonej tabeli łącznika.

Parameters

Ustaw wartości dla tych wymaganych parametrów.

Name	Typ	Description
connectorLogicalName	string	Nazwa logiczna odwołania połączenia powiązana ze stroną.
dataset	string	Zestaw danych zawierający tabelę.
tableName	string	Wewnętrzna nazwa tabeli z name właściwości zwróconej przez listConnectorTables. Nie używaj nazwy wyświetlanej.
id	string	Identyfikator wiersza do zaktualizowania.
row	object	Dane wierszy do zaktualizowania.

Returns

Obietnica zawierająca treść odpowiedzi zwróconą przez łącznik, jeśli istnieje. W zależności od łącznika ta wartość może być zaktualizowanym wierszem, wierszem częściowym lub bez wartości. Aby odczytać bieżące wartości wiersza, wywołaj metodę retrieveConnectorRow.

updateConnectorRow — przykład

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

Metoda deleteConnectorRow

Usuwa wiersz z określonej tabeli łącznika.

Parameters

Ustaw wartości dla tych wymaganych parametrów.

Name	Typ	Description
connectorLogicalName	string	Nazwa logiczna odwołania połączenia powiązana ze stroną.
dataset	string	Zestaw danych zawierający tabelę.
tableName	string	Wewnętrzna nazwa tabeli z name właściwości zwróconej przez listConnectorTables. Nie używaj nazwy wyświetlanej.
id	string	Identyfikator wiersza do usunięcia.

Returns

Obietnica zawierająca wynik operacji. Gdy operacja zakończy się pomyślnie, nie zwraca żadnej wartości.

przykład 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"
);

Metoda executeConnectorOperation

Wywołuje nazwaną operację uwidacznianą przez łącznik REST (klucz operacji), taki jak HTTP, Wysyłanie wiadomości w usłudze Teams lub Użytkownicy usługi Office 365. Zamiast tego łączniki tabelaryczne powinny używać metod CRUD zapytania i wiersza.

Parameters

Ustaw wartości dla tych wymaganych parametrów.

Name	Typ	Description
connectorLogicalName	string	Nazwa logiczna odwołania połączenia powiązana ze stroną.
operationName	string	Identyfikator operacji zdefiniowany w definicji struktury Swagger łącznika.
parameters	object	Parametry wymagane przez operację. Przekaż pusty obiekt ({}), jeśli operacja nie przyjmuje żadnych parametrów — ten parametr jest wymagany nawet wtedy, gdy nie ma nic do wysłania.

Returns

Obietnica zawierająca wynik operacji z tymi właściwościami. Obietnica odrzuca, jeśli nie można rozpoznać odwołania do połączenia, nie można pobrać definicji programu Swagger łącznika, nie można odnaleźć w niej operacji, nie można wysłać wywołania lub połączenie nie jest autoryzowane (HTTP 403), a użytkownik nie ukończy monitu o wyrażenie zgody połączenia.

Name	Typ	Description
ok	boolean	true gdy podstawowy stan HTTP jest mniejszy niż 400. Ten stan obejmuje stany przekierowania (3xx), więc nie traktuj ok go samodzielnie jako dowodu zwróconych danych — sprawdź również lub sprawdź statusbody.
status	number	Nieprzetworzony kod stanu HTTP zwrócony przez łącznik.
body	unknown	Przeanalizowana treść odpowiedzi JSON lub nieprzetworzony ciąg, jeśli treść nie jest plikiem JSON.

przykład executeConnectorOperation

W poniższym przykładzie przyjęto założenie, że operacja o nazwie CopyFile akceptuje sourceUrl parametry i destinationUrl . Przed jego użyciem sprawdź identyfikator operacji i jego parametry względem własnej definicji programu Swagger łącznika (na przykład z listConnectorOperations lub getConnectorSwagger), ponieważ dostępne operacje i ich parametry różnią się w zależności od łącznika.

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