Métodos de tabla de Dataverse para páginas generativas

Use los métodos de tabla del dataApi objeto para crear, recuperar, actualizar y eliminar filas de tabla de Dataverse y columnas de elección de consulta.

Método Description
createRow Crea una nueva fila en la tabla especificada.
deleteRow Elimina una fila de la tabla especificada.
getChoices Recupera las opciones para el nombre de columna de elección especificado.
queryTable Consulta una tabla con las opciones especificadas.
retrieveRow Recupera una fila de la tabla especificada con las opciones especificadas.
updateRow Actualiza una fila existente en la tabla especificada.

método createRow

Crea una nueva fila en la tabla especificada.

Parameters

Establezca valores para estos parámetros necesarios.

Name Tipo Description
tableName string Nombre lógico de la tabla en la que se va a crear la fila.
row object Datos de fila que se van a crear.

Devoluciones

Promesa que contiene el resultado de la operación. Cuando la operación se realiza correctamente, el resultado es el valor id. (GUID) de la fila creada.

Ejemplo de createRow

// Define the row data to create new account
var row =
    {
        "name": "Sample Account",
        "creditonhold": false,
        "address1_latitude": 47.639583,
        "description": "This is the description of the sample account",
        "revenue": 5000000,
        "accountcategorycode": 1,
    }

try {
  // Create a new account record
  const newAccountId = await dataApi.createRow("account", row);
  console.log("Account created with ID: " + newAccountId);

  // Create a contact with a lookup to an account
  const newContactId = await dataApi.createRow('contact', {
    firstname: 'John',
    lastname: 'Doe',
    emailaddress1: 'john.doe@contoso.com',
    "parentcustomerid@odata.bind": `/account(${newAccountId})`, // Lookup format
  });
}
catch (error) {
  console.log(error.message);
}

método deleteRow

Elimina una fila de la tabla especificada.

Parameters

Establezca valores para estos parámetros necesarios.

Name Tipo Description
tableName string Nombre lógico de la tabla en la que se va a eliminar la fila.
rowId string Identificador de la fila que se va a eliminar.

Devoluciones

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

Ejemplo de deleteRow

let rowId = "5531d753-95af-e711-a94e-000d3a11e605";
try {
  await dataApi.deleteRow("account", rowId);
}
catch (error) {
  console.log(error.message);
}

método getChoices

Recupera las opciones para el nombre de columna de elección especificado.

Parameters

Este parámetro es obligatorio.

Name Tipo Description
enumName string Nombre de la columna de elección en el formato tablename-columnname

Devoluciones

Promesa que contiene el resultado de la operación. Cuando la operación se realiza correctamente, devuelve una matriz de las opciones de elección. Cada opción tiene estas propiedades:

Name Tipo Description
label string Valor de etiqueta localizado de la opción.
value número Valor numérico de la opción.

Ejemplo de getChoices

// Returns the accountcategorycode column options from the account table
const categoryChoices = await dataApi.getChoices("account-accountcategorycode");
// Returns the statecode column options from the contact table
const stateChoices = await dataApi.getChoices('contact-statecode');
// Returns the statuscode column options from the account table
const statusChoices = await dataApi.getChoices('account-statuscode');

método queryTable

Consulta una tabla mediante las opciones especificadas.

Parameters

Establezca valores para estos parámetros necesarios.

Name Tipo Description
tableName string Nombre lógico de la tabla que se va a consultar
query QueryTableOptions Opciones para consultar la tabla

QueryTableOptions

Name Tipo Description
select string[] (Recomendado) Matriz de nombres de columna que se van a recuperar.
filter string (Opcional) Expresión de filtro de OData (por ejemplo, statecode eq 0).
orderBy string (Opcional) Expresión orderby de OData (por ejemplo, name asc, createdon desc).
pageSize number (Opcional) Número máximo de filas que se van a devolver por página.

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:

Name Tipo Description
rows Object[] Matriz de datos de fila
hasMoreRows boolean Indica si hay más filas disponibles.
loadMoreRows function Función para cargar la siguiente página de resultados. (Opcional)

ejemplo de queryTable

// Query tasks with options
const result = await dataApi.queryTable("task", {
    select: ["activityid", "subject", "scheduledend", "prioritycode", "statecode"],
    orderBy: "scheduledend asc",
    pageSize: 50,
    filter: "statecode eq 0"
});

// Query accounts with pagination
const pagedAccounts = await dataApi.queryTable('account', {
  select: ['name'],
  pageSize: 50,
});

console.log(`Page 1: ${pagedAccounts.rows.length} accounts`);

if (pagedAccounts.hasMoreRows && pagedAccounts.loadMoreRows) {
  const nextPage = await pagedAccounts.loadMoreRows();
  console.log(`Page 2: ${nextPage.rows.length} accounts`);
}

Remarks

Note

Para obtener el mejor rendimiento, limite siempre el número de columnas devueltas mediante la propiedad QueryTableOptionsselect .

método retrieveRow

Recupera una fila de la tabla especificada mediante las opciones especificadas.

Parameters

Establezca valores para estos parámetros necesarios.

Name Tipo Description
tableName string Nombre lógico de la tabla de la que se va a recuperar
options RetrieveRowOptions Opciones para recuperar la fila

RetrieveRowOptions

Name Tipo Description
id string Identificador (GUID) de la fila que se va a recuperar
select string[] (Recomendado) Matriz de nombres de columna que se van a recuperar. Si se omite, se devuelven todas las columnas.

Devoluciones

Promesa que contiene el resultado de la operación. Cuando la operación se realiza correctamente, devuelve un objeto con los datos de registro, incluidas todas las columnas seleccionadas.

Ejemplo de retrieveRow

// Retrieve an account with all columns
const account = await dataApi.retrieveRow('account', {
  id: '30dc51e9-947d-47d8-ad48-4fc48fba4a95',
});

// Retrieve specific columns only
const contact = await dataApi.retrieveRow('contact', {
  id: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
  select: ['firstname', 'lastname', '_parentcustomerid_value'],
});

método updateRow

Actualiza una fila existente en la tabla especificada.

Parameters

Establezca valores para estos parámetros necesarios.

Name Tipo Description
tableName string Nombre lógico de la tabla en la que se va a actualizar la fila.
rowId string Identificador de la fila que se va a actualizar.
row Object Datos de fila que se van a actualizar.

Devoluciones

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

Ejemplo de updateRow

let rowId = "5531d753-95af-e711-a94e-000d3a11e605"

// Define the row to update a record
var row =
    {
        "name": "Updated Sample Account ",
        "creditonhold": true,
        "address1_latitude": 47.639583,
        "description": "This is the updated description of the sample account",
        "revenue": 6000000,
        "accountcategorycode": 2
    }

// update the record

try {
   await dataApi.updateRow("account", rowId, row);
}
catch (error){
  console.log(error.message);
}