Andmeversiooni tabelimeetodid generatiivsete lehtede jaoks

Kasutage objekti tabelimeetodeid dataApi andmetabeliridade ja päringuvalikuveergude loomiseks, toomiseks, värskendamiseks ja kustutamiseks.

Meetod	Kirjeldus
createRow	Loob määratud tabelis uue rea.
deleteRow	Kustutab määratud tabelist rea.
getChoices	Toob määratud valikuveeru nime valikud.
queryTable	Esitab määratud suvanditega tabelipäringu.
retrieveRow	Toob määratud tabelist rea määratud suvanditega.
updateRow	Värskendab määratud tabelis olemasoleva rea.

createRow Meetod

Loob määratud tabelis uue rea.

Parameetrid

Seadke nende nõutavate parameetrite väärtused.

Nimi	Tüüp	Kirjeldus
tableName	string	Tabeli loogiline nimi, kus rida luua.
row	ese	Loodavad reaandmed.

Tagastused

Lubadus, mis sisaldab operatsiooni tulemust. Kui toiming õnnestub, on tulemiks loodud rea ID (GUID) väärtus.

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 Meetod

Kustutab määratud tabelist rea.

Parameetrid

Seadke nende nõutavate parameetrite väärtused.

Nimi	Tüüp	Kirjeldus
tableName	string	Tabeli loogiline nimi, kus rida kustutada.
rowId	string	Kustutatava rea ID.

Tagastused

Lubadus, mis sisaldab operatsiooni tulemust. Toimingu õnnestumisel ei tagastata väärtust.

deleteRow example

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

getChoices Meetod

Toob määratud valikuveeru nime valikud.

Parameetrid

See parameeter on kohustuslik.

Nimi	Tüüp	Kirjeldus
enumName	string	Valikuveeru nimi vormingus tablename-columnname

Tagastused

Lubadus, mis sisaldab operatsiooni tulemust. Toimingu õnnestumisel tagastab see valikusuvandite massiivi. Igal suvandil on järgmised atribuudid.

Nimi	Tüüp	Kirjeldus
label	string	Suvandi lokaliseeritud sildi väärtus.
value	number	Suvandi arvväärtus.

getChoicesi näide

// 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 Meetod

Esitab tabelile päringu määratud suvandite abil.

Parameetrid

Seadke nende nõutavate parameetrite väärtused.

Nimi	Tüüp	Kirjeldus
tableName	string	Päringuks oleva tabeli loogiline nimi
query	QueryTableOptions	Tabelipäringu suvandid

QueryTableOptions

Nimi	Tüüp	Kirjeldus
select	string[]	(Soovitatav) Toodavate veerunimede massiiv.
filter	string	(Valikuline) OData filtriavaldis (nt statecode eq 0).
orderBy	string	(Valikuline) OData orderby avaldis (nt name asc, createdon desc).
pageSize	number	(Valikuline) Suurim tagastatavate ridade arv lehel.

Tagastused

Lubadus, mis sisaldab operatsiooni tulemust. Kui toiming õnnestub, tagastab lubadus järgmise atribuudiga andmetabelit sisaldava objekti:

Nimi	Tüüp	Kirjeldus
rows	Object[]	Reaandmete massiiv
hasMoreRows	boolean	Näitab, kas saadaval on rohkem ridu
loadMoreRows	function	Funktsioon järgmise tulemilehe laadimiseks. (Valikuline)

QueryTable-liigendtabeli näide

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

Märkused

Märkus.

Parima jõudluse huvides piirake alati atribuudi QueryTableOptionsselect abil tagastatavate veergude arvu.

retrieveRow Meetod

Toob määratud tabelist rea määratud suvandite abil.

Parameetrid

Seadke nende nõutavate parameetrite väärtused.

Nimi	Tüüp	Kirjeldus
tableName	string	Toodava tabeli loogiline nimi
options	RetrieveRowOptions	Suvandid rea toomiseks

RetrieveRowOptions

Nimi	Tüüp	Kirjeldus
id	string	Toodava rea ID (GUID)
select	string[]	(Soovitatav) Toodavate veerunimede massiiv. Kui see puudub, tagastatakse kõik veerud.

Tagastused

Lubadus, mis sisaldab operatsiooni tulemust. Toimingu õnnestumisel tagastab see kirjeandmetega objekti (sh kõik valitud veerud).

retrieveRow example

// 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 Meetod

Värskendab määratud tabelis olemasoleva rea.

Parameetrid

Seadke nende nõutavate parameetrite väärtused.

Nimi	Tüüp	Kirjeldus
tableName	string	Tabeli loogiline nimi rea värskendamiseks.
rowId	string	Värskendatava rea ID.
row	Objekt	Värskendatavad reaandmed.

Tagastused

Lubadus, mis sisaldab operatsiooni tulemust. Toimingu õnnestumisel ei tagastata väärtust.

updateRow näide

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