Métodos de conector para páginas generativas

Use los métodos de conector del dataApi objeto para trabajar con los datos expuestos por un conector de Power Platform enlazado a la página.

método queryConnectorTable

Consulta una tabla expuesta por el conector mediante las opciones especificadas.

Parameters

Establezca valores para estos parámetros necesarios.

QueryConnectorTableOptions

Devoluciones

Promesa que contiene el resultado de la operación. Cuando la operación se realiza correctamente, la promesa devuelve un objeto que contiene una tabla de datos con los resultados con estas propiedades:

queryConnectorTable devuelve una sola página de resultados. No devuelve una función de continuación y actualmente no hay ninguna manera admitida de capturar la página siguiente. Cuando hasMoreRows es true, se devolvieron más filas que las devueltas. Restrinja la consulta con filtero indique al usuario que los resultados están incompletos.

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

En los ejemplos siguientes se supone documentsTableName que contiene la tabla name de listConnectorTables, como se muestra anteriormente.

método listConnectorTables

Enumera las tablas (listas o entidades) disponibles en el conjunto de datos del conector especificado.

Parameters

Establezca valores para estos parámetros necesarios.

Devoluciones

Promesa que contiene una matriz de información de tabla. Cada entrada tiene estas propiedades:

Ejemplo de listConnectorTables

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

método listConnectorDatasets

Enumera los conjuntos de datos disponibles para el conector, como los sitios de SharePoint a los que puede acceder una conexión.

Parameters

Establezca un valor para este parámetro necesario.

Devoluciones

Promesa que contiene una matriz de información del conjunto de datos. Cada entrada tiene estas propiedades:

Ejemplo de listConnectorDatasets

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

método listConnectorOperations

Enumera las operaciones definidas en la definición de Swagger del conector, excepto las operaciones marcadas como internas, ordenadas por nombre para mostrar. Este método es más útil para conectores REST (con clave de operación), como Usuarios de Office 365. En el caso de los conectores tabulares, use los métodos de consulta y fila en lugar de las operaciones que muestra este método.

Parameters

Establezca un valor para este parámetro necesario.

Devoluciones

Promesa que contiene una matriz de información de operación. Cada entrada tiene estas propiedades:

Ejemplo de listConnectorOperations

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

método getConnectorSwagger

Recupera la definición de Swagger (OpenAPI) para el conector, que describe las operaciones que expone. El documento devuelto describe el conector en general. No incluye esquemas de columna por tabla para conectores tabulares. Use getConnectorTableSchema para esa información.

Parameters

Establezca un valor para este parámetro necesario.

Devoluciones

Promesa que contiene la definición de Swagger del conector como un objeto .

Ejemplo de 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"
);

método getConnectorTableSchema

Recupera el esquema (definiciones de columna) de una tabla expuesta por el conector. El conector define el esquema que devuelve y varía según el conector. No suponga que incluye todas las columnas dinámicas que puede contener una tabla.

Parameters

Establezca valores para estos parámetros necesarios.

Devoluciones

Promesa que contiene el esquema de la tabla como un objeto .

Ejemplo de 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
);

método retrieveConnectorRow

Recupera una sola fila de la tabla de conectores especificada.

Parameters

Establezca valores para estos parámetros necesarios.

RetrieveConnectorRowOptions

Devoluciones

Promesa que contiene los datos de fila.

Ejemplo de 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"
);

método createConnectorRow

Crea una nueva fila en la tabla de conectores especificada.

Parameters

Establezca valores para estos parámetros necesarios.

Devoluciones

Promesa que contiene el cuerpo de respuesta devuelto por el conector, si existe. Dependiendo del conector, este valor puede ser la fila creada, una fila parcial o ningún valor.

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

método updateConnectorRow

Actualiza una fila existente en la tabla de conectores especificada.

Parameters

Establezca valores para estos parámetros necesarios.

Devoluciones

Promesa que contiene el cuerpo de respuesta devuelto por el conector, si existe. Según el conector, este valor puede ser la fila actualizada, una fila parcial o ningún valor. Para leer los valores actuales de la fila, llame a retrieveConnectorRow.

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

método deleteConnectorRow

Elimina una fila de la tabla de conectores especificada.

Parameters

Establezca valores para estos parámetros necesarios.

Devoluciones

Promesa que contiene el resultado de la operación. Cuando la operación se realiza correctamente, no devuelve ningún valor.

Ejemplo de 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"
);

método executeConnectorOperation

Invoca una operación con nombre expuesta por un conector REST (con clave de operación), como HTTP, mensaje de envío de Teams o Usuarios de Office 365. En su lugar, los conectores tabulares deben usar los métodos CRUD de consulta y fila.

Parameters

Establezca valores para estos parámetros necesarios.

Devoluciones

Promesa que contiene el resultado de la operación con estas propiedades. La promesa rechaza si no se puede resolver la referencia de conexión, la definición de Swagger del conector no se puede recuperar, la operación no se encuentra en ella, la llamada no se puede enviar o la conexión no está autorizada (HTTP 403) y el usuario no completa la solicitud de consentimiento de conexión.

Ejemplo executeConnectorOperation

En el ejemplo siguiente se presupone una operación denominada CopyFile que acepta parámetros sourceUrl y destinationUrl . Compruebe el identificador de operación y sus parámetros en la propia definición de Swagger del conector (por ejemplo, con listConnectorOperations o getConnectorSwagger) antes de usarlo, ya que las operaciones disponibles y sus parámetros varían según el conector.

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