Dataverse table methods for generative pages

Використовуйте методи dataApi таблиці об'єкта, щоб створювати, отримувати, оновлювати та видаляти рядки таблиці Dataverse і стовпці вибору запиту.

Метод	Опис
createRow	Створення нового рядка у вказаній таблиці.
deleteRow	Видалення рядка з указаної таблиці.
getChoices	Отримує варіанти для вказаного імені стовпця вибору.
queryTable	Запитує таблицю з указаними параметрами.
retrieveRow	Отримує рядок із вказаної таблиці з указаними параметрами.
updateRow	Оновлення наявного рядка у вказаній таблиці.

createRow метод

Створення нового рядка у вказаній таблиці.

Параметри

Установлення значень для цих обов'язкових параметрів.

Ім'я	Тип	Опис
tableName	рядок	Логічне ім'я таблиці для створення рядка.
row	об'єкт	Дані рядка, які потрібно створити.

Відповіді

Обіцянка, що містить результат операції. Коли операцію буде виконано успішно, результатом буде значення ідентифікатора (GUID) створеного рядка.

createRow example

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

deleteRow метод

Видалення рядка з указаної таблиці.

Параметри

Установлення значень для цих обов'язкових параметрів.

Ім'я	Тип	Опис
tableName	рядок	Логічне ім'я таблиці, у якій потрібно видалити рядок.
rowId	рядок	Ідентифікатор рядка, який потрібно видалити.

Відповіді

Обіцянка, що містить результат операції. Коли операцію буде виконано успішно, вона не повертає значення.

deleteRow example

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

getChoices метод

Отримує варіанти для вказаного імені стовпця вибору.

Параметри

Цей параметр є обов'язковим.

Ім'я	Тип	Опис
enumName	string	Ім'я стовпця вибору у форматі tablename-columnname

Відповіді

Обіцянка, що містить результат операції. Коли операцію буде виконано успішно, вона повертає масив варіантів вибору. Кожен параметр має такі властивості:

Ім'я	Тип	Опис
label	рядок	Локалізоване значення підпису параметра.
value	number	Числове значення параметра.

getChoices example

// 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');

queryTable метод

Запитує таблицю за допомогою вказаних параметрів.

Параметри

Установлення значень для цих обов'язкових параметрів.

Ім'я	Тип	Опис
tableName	string	Логічне ім'я таблиці для запиту
query	Об'єднання таблиць запитів	Параметри запиту таблиці

Об'єднання таблиць запитів

Ім'я	Тип	Опис
select	string[]	(Рекомендовано) Масив імен стовпців, які потрібно отримати.
filter	string	(Необов'язково) Вираз фільтра OData (наприклад, statecode eq 0).
orderBy	string	(Необов'язково) Вираз порядку OData (наприклад, name asc, , createdon desc).
pageSize	number	(Необов'язково) Максимальна кількість рядків для повернення на сторінку.

Відповіді

Обіцянка, що містить результат операції. Коли операцію буде виконано успішно, обіцянка повертає об'єкт, що містить таблицю даних із результатами з такими властивостями:

Ім'я	Тип	Опис
rows	Object[]	Масив даних рядків
hasMoreRows	boolean	Указує, чи доступно більше рядків
loadMoreRows	function	Функція для завантаження наступної сторінки результатів. (необов’язково)

Приклад таблиці запитів

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

Примітки

Нотатка

Щоб забезпечити максимальну продуктивність, завжди обмежуйте кількість стовпців, які повертаються за допомогою властивості QueryTableOptionsselect .

retrieveRow метод

Отримує рядок із вказаної таблиці за допомогою вказаних параметрів.

Параметри

Установлення значень для цих обов'язкових параметрів.

Ім'я	Тип	Опис
tableName	string	Логічне ім'я таблиці, з яких потрібно отримати
options	Отримання об'їв	Параметри отримання рядка

Отримання об'їв

Ім'я	Тип	Опис
id	string	Ідентифікатор (GUID) рядка для отримання
select	string[]	(Рекомендовано) Масив імен стовпців, які потрібно отримати. Якщо не вказано, повертаються всі стовпці.

Відповіді

Обіцянка, що містить результат операції. Коли операцію буде виконано успішно, вона повертає об'єкт із даними запису, включно з усіма вибраними стовпцями.

отримання прикладу "Зазем'я"

// 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'],
});

updateRow метод

Оновлення наявного рядка у вказаній таблиці.

Параметри

Установлення значень для цих обов'язкових параметрів.

Ім'я	Тип	Опис
tableName	рядок	Логічне ім'я таблиці для оновлення рядка.
rowId	рядок	Ідентифікатор рядка для оновлення.
row	Об'єкт	Дані рядка, які потрібно оновити.

Відповіді

Обіцянка, що містить результат операції. Коли операцію буде виконано успішно, вона не повертає значення.

updateRow example

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