Phương pháp đường kết nối để tạo trang

Sử dụng phương pháp đường kết nối của đối dataApi tượng để làm việc với dữ liệu được bộ nối Power Platform hiển thị gắn với trang.

Lưu ý

Phương pháp trình kết nối là tùy chọn trong hợp đồng dataApi dùng chung. Một số máy chủ không thực hiện chúng, vì vậy hãy kiểm tra xem phương pháp có tồn tại trước khi gọi nó không. Phương pháp đang trình bày không có nghĩa là trang có một trình kết nối được liên kết với nó hoặc kết nối, tập dữ liệu, bảng hoặc thao tác được đặt cấu hình, cho phép hoặc cho phép như mong đợi.

Không giống như phương pháp hành động và chức năng, các phương pháp đường kết nối từ chối lời hứa trả về khi một cuộc gọi không thành công — ví dụ, khi không thể giải quyết tham chiếu kết nối, kết nối không được ủy quyền và người dùng không hoàn thành lời nhắc chấp thuận hoặc bộ nối trả về trạng thái lỗi. executeConnectorOperation giải quyết ok: false với hầu hết các trạng thái lỗi, nhưng vẫn từ chối cho một thao tác bị thiếu, một kết nối trái phép (403) mà không có sự chấp thuận hoàn thành, hoặc một lỗi vận chuyển. Ngắt dòng cuộc gọi bộ kết nối trong try/catch.

Phương pháp Mô tả
createConnectorRow Tạo hàng mới trong bảng bộ kết nối đã xác định.
deleteConnectorRow Xóa bỏ một hàng khỏi bảng bộ kết nối đã xác định.
executeConnectorOperation Gọi ra một thao tác đã đặt tên được bộ nối REST (phím thao tác) hiển thị, chẳng hạn như Người dùng Office 365.
getConnectorSwagger Truy xuất định nghĩa Swagger (OpenAPI) cho bộ kết nối.
getConnectorTableSchema Truy xuất sơ đồ cho bảng (còn gọi là thực thể hoặc danh sách) mà bộ kết nối hiển thị.
listConnectorDatasets Liệt kê các tập dữ liệu sẵn dùng cho bộ kết nối.
listConnectorOperations Liệt kê các thao tác được trình kết nối REST (phím thao tác) hiển thị.
listConnectorTables Liệt kê các bảng sẵn dùng trong tập dữ liệu bộ kết nối đã xác định.
queryConnectorTable Truy vấn bảng được bộ kết nối hiển thị với các tùy chọn đã xác định.
retrieveConnectorRow Truy xuất một hàng đơn từ bảng bộ kết nối đã xác định.
updateConnectorRow Cập nhật hàng hiện có trong bảng bộ kết nối đã xác định.

queryConnectorTable phương pháp

Truy vấn bảng được bộ kết nối hiển thị bằng cách sử dụng các tùy chọn đã xác định.

Tham số

Đặt giá trị cho các tham số bắt buộc này.

Tên Loại Mô tả
connectorLogicalName string Tên lô-gic của tham chiếu kết nối được liên kết với trang (ví dụ: sp_shared_sharepointonline).
dataset string Tập dữ liệu chứa bảng, chẳng hạn như URL SharePoint trang web.
tableName string Tên nội bộ của bảng, từ thuộc tính được name trả về bởi listConnectorTables. Không sử dụng tên hiển thị.
options QueryConnectorTableOptions Tùy chọn để truy vấn bảng.

QueryConnectorTableOptions

Tên Loại Mô tả
select string[] (Được đề xuất) Mảng tên cột cần truy xuất.
filter string (Tùy chọn) Biểu thức lọc được bộ kết nối hỗ trợ.
orderBy string (Tùy chọn) Biểu thức theo thứ tự được bộ nối hỗ trợ.
top number (Tùy chọn) Số hàng tối đa để trả về.

Trả về

Một lời hứa có chứa kết quả của hoạt động. Khi thao tác thành công, promise sẽ trả về một đối tượng có chứa một bảng dữ liệu với kết quả với các thuộc tính này:

Tên Loại Mô tả
rows Object[] Mảng dữ liệu hàng.
hasMoreRows boolean Cho biết có nhiều hàng hơn không.

queryConnectorTable trả về một trang kết quả duy nhất. Hàm này không trả về hàm tiếp tục và hiện không có cách nào được hỗ trợ để tải trang tiếp theo. Khi hasMoreRows là true, nhiều hàng khớp hơn số hàng được trả về. Thu hẹp truy vấn filtervới , hoặc cho người dùng biết kết quả không đầy đủ.

ví dụ về 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,
  }
);

Các ví dụ sau đây giả documentsTableName định chứa bảng từ namelistConnectorTables, như minh họa ở trên.

listConnectorTables phương pháp

Liệt kê các bảng (danh sách hoặc thực thể) sẵn dùng trong tập dữ liệu bộ kết nối đã xác định.

Tham số

Đặt giá trị cho các tham số bắt buộc này.

Tên Loại Mô tả
connectorLogicalName string Tên lô-gic của tham chiếu kết nối được liên kết với trang.
dataset string Tập dữ liệu để liệt kê các bảng cho.

Trả về

Lời hứa chứa một mảng thông tin bảng. Mỗi mục nhập có các thuộc tính sau:

Tên Loại Mô tả
name string Tên nội bộ của bảng.
displayName string Tên hiển thị của bảng.

ví dụ về listConnectorTables

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

listConnectorDatasets phương pháp

Liệt kê các tập dữ liệu sẵn dùng cho bộ kết nối, chẳng hạn như các trang SharePoint mà một kết nối có thể truy nhập.

Tham số

Đặt giá trị cho tham số bắt buộc này.

Tên Loại Mô tả
connectorLogicalName string Tên lô-gic của tham chiếu kết nối được liên kết với trang.

Trả về

Lời hứa chứa một mảng thông tin tập dữ liệu. Mỗi mục nhập có các thuộc tính sau:

Tên Loại Mô tả
name string Tên nội bộ hoặc mã định danh của tập dữ liệu.
displayName string Tên hiển thị của tập dữ liệu.

ví dụ về listConnectorDatasets

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

listConnectorOperations phương pháp

Liệt kê các thao tác được xác định trong định nghĩa Swagger của bộ kết nối, ngoại trừ các thao tác được đánh dấu nội bộ, sắp xếp theo tên hiển thị. Phương pháp này hữu ích nhất cho các trình kết nối REST (phím thao tác), chẳng hạn Người dùng Office 365. Đối với bộ nối dạng bảng, hãy sử dụng các phương pháp truy vấn và hàng thay vì các thao tác mà phương pháp này liệt kê.

Tham số

Đặt giá trị cho tham số bắt buộc này.

Tên Loại Mô tả
connectorLogicalName string Tên lô-gic của tham chiếu kết nối được liên kết với trang.

Trả về

Lời hứa chứa một mảng thông tin thao tác. Mỗi mục nhập có các thuộc tính sau:

Tên Loại Mô tả
name string ID thao tác như được định nghĩa trong định nghĩa Swagger của bộ kết nối. Chuyển giá trị này tới executeConnectorOperation.
displayName string Tên thao tác mà con người có thể đọc được để hiển thị, chẳng hạn như tóm tắt Swagger. Quay trở lại nếu name không có tóm tắt nào được xác định.

ví dụ về listConnectorOperations

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

getConnectorSwagger phương pháp

Truy xuất định nghĩa Swagger (OpenAPI) cho bộ kết nối, mô tả các thao tác mà nó hiển thị. Tài liệu được trả về mô tả tổng thể bộ nối. Sơ đồ không bao gồm sơ đồ cột cho mỗi bảng cho đường kết nối dạng bảng. Sử dụng getConnectorTableSchema cho thông tin đó.

Tham số

Đặt giá trị cho tham số bắt buộc này.

Tên Loại Mô tả
connectorApiId string Mã định danh API bộ kết nối, chẳng hạn như /providers/Microsoft.PowerApps/apis/shared_sharepointonline. Mã định danh này khác với tên lô-gic tham chiếu kết nối (connectorLogicalName) được hầu hết các phương pháp kết nối khác sử dụng.

Trả về

Lời hứa chứa định nghĩa Swagger của bộ kết nối như một đối tượng.

ví dụ về 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 phương pháp

Truy xuất sơ đồ (định nghĩa cột) cho bảng được bộ kết nối hiển thị. Trình kết nối xác định sơ đồ mà nó trả về và nó thay đổi theo đường kết nối. Đừng giả sử bảng chứa mọi cột động mà bảng có thể chứa.

Tham số

Đặt giá trị cho các tham số bắt buộc này.

Tên Loại Mô tả
connectorLogicalName string Tên lô-gic của tham chiếu kết nối được liên kết với trang.
dataset string Tập dữ liệu chứa bảng.
tableName string Tên nội bộ của bảng, từ thuộc tính được name trả về bởi listConnectorTables. Không sử dụng tên hiển thị.

Trả về

Lời hứa chứa sơ đồ của bảng dưới dạng đối tượng.

ví dụ về 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 phương pháp

Truy xuất một hàng đơn từ bảng bộ kết nối đã xác định.

Tham số

Đặt giá trị cho các tham số bắt buộc này.

Tên Loại Mô tả
connectorLogicalName string Tên lô-gic của tham chiếu kết nối được liên kết với trang.
dataset string Tập dữ liệu chứa bảng.
tableName string Tên nội bộ của bảng, từ thuộc tính được name trả về bởi listConnectorTables. Không sử dụng tên hiển thị.
id string ID của hàng cần truy xuất.
options RetrieveConnectorRowOptions (Tùy chọn) Tùy chọn để truy xuất hàng.

RetrieveConnectorRowOptions

Tên Loại Mô tả
select string[] (Được đề xuất) Mảng tên cột cần truy xuất. Nếu bị bỏ qua, sẽ không $select có chiếu nào được gửi đi — bộ nối sẽ xác định cột nào sẽ trả về và không đảm bảo trả về mọi cột trong hàng.

Trả về

Lời hứa chứa dữ liệu hàng.

ví dụ 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 phương pháp

Tạo hàng mới trong bảng bộ kết nối đã xác định.

Tham số

Đặt giá trị cho các tham số bắt buộc này.

Tên Loại Mô tả
connectorLogicalName string Tên lô-gic của tham chiếu kết nối được liên kết với trang.
dataset string Tập dữ liệu chứa bảng.
tableName string Tên nội bộ của bảng, từ thuộc tính được name trả về bởi listConnectorTables. Không sử dụng tên hiển thị.
row object Dữ liệu hàng cần tạo.

Trả về

Một lời hứa có chứa nội dung phản hồi được trình kết nối trả về, nếu có. Tùy thuộc vào bộ nối, giá trị này có thể là hàng đã tạo, hàng một phần hoặc không có giá trị.

ví dụ về 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 phương pháp

Cập nhật hàng hiện có trong bảng bộ kết nối đã xác định.

Tham số

Đặt giá trị cho các tham số bắt buộc này.

Tên Loại Mô tả
connectorLogicalName string Tên lô-gic của tham chiếu kết nối được liên kết với trang.
dataset string Tập dữ liệu chứa bảng.
tableName string Tên nội bộ của bảng, từ thuộc tính được name trả về bởi listConnectorTables. Không sử dụng tên hiển thị.
id string ID của hàng cần cập nhật.
row object Dữ liệu hàng cần cập nhật.

Trả về

Một lời hứa có chứa nội dung phản hồi được trình kết nối trả về, nếu có. Tùy thuộc vào bộ nối, giá trị này có thể là hàng cập nhật, hàng một phần hoặc không có giá trị. Để đọc các giá trị hiện tại của hàng, hãy gọi retrieveConnectorRow.

ví dụ về 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 phương pháp

Xóa bỏ một hàng khỏi bảng bộ kết nối đã xác định.

Tham số

Đặt giá trị cho các tham số bắt buộc này.

Tên Loại Mô tả
connectorLogicalName string Tên lô-gic của tham chiếu kết nối được liên kết với trang.
dataset string Tập dữ liệu chứa bảng.
tableName string Tên nội bộ của bảng, từ thuộc tính được name trả về bởi listConnectorTables. Không sử dụng tên hiển thị.
id string ID của hàng cần xóa.

Trả về

Một lời hứa có chứa kết quả của hoạt động. Khi thao tác thành công, nó không trả về giá trị nào.

ví dụ 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 phương pháp

Gọi ra một thao tác đã đặt tên được bộ nối REST (phím thao tác) hiển thị, chẳng hạn như HTTP, Teams send-message hoặc Người dùng Office 365. Các đường kết nối dạng bảng nên sử dụng các phương pháp CRUD truy vấn và hàng để thay thế.

Tham số

Đặt giá trị cho các tham số bắt buộc này.

Tên Loại Mô tả
connectorLogicalName string Tên lô-gic của tham chiếu kết nối được liên kết với trang.
operationName string ID thao tác như được định nghĩa trong định nghĩa Swagger của bộ kết nối.
parameters object Các tham số được yêu cầu bởi thao tác. Truyền đối tượng trống ({}) nếu thao tác không có tham số — bắt buộc phải có tham số này ngay cả khi không có gì để gửi.

Trả về

Lời hứa chứa kết quả thao tác với các thuộc tính này. Lời hứa sẽ từ chối nếu không thể giải quyết tham chiếu kết nối, không truy xuất được định nghĩa Swagger của bộ kết nối, không tìm thấy thao tác trong đó, không thể gửi cuộc gọi hoặc kết nối không được ủy quyền (HTTP 403) và người dùng không hoàn tất lời nhắc chấp thuận kết nối.

Tên Loại Mô tả
ok boolean true khi trạng thái HTTP cơ sở nhỏ hơn 400. Trạng thái này bao gồm các trạng thái chuyển hướng (3xx), ok vì vậy đừng coi riêng thao tác này là bằng chứng cho thao tác trả về dữ liệu — status cũng kiểm tra hoặc kiểm tra body.
status number Mã trạng thái HTTP thô do bộ kết nối trả về.
body unknown Nội dung phản hồi JSON được phân tích hoặc chuỗi thô nếu nội dung không phải là JSON.

ví dụ về executeConnectorOperation

Ví dụ sau đây giả định một thao tác có tên CopyFile là chấp nhận và sourceUrl tham destinationUrl số. Xác nhận ID thao tác và các tham số của nó dựa trên định nghĩa Swagger của riêng bộ kết nối (ví dụ, listConnectorOperationsgetConnectorSwaggervới hoặc ) trước khi sử dụng nó, vì các thao tác sẵn dùng và các tham số của chúng khác nhau tùy theo trình kết nối.

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