Megosztás:


dataApi-referencia generatív oldalakhoz

Amikor természetes nyelv használatával hoz létre lapot, az AI létrehoz egy React-lapot a TypeScriptben. A létrehozott oldal a megfelelő összetevők kiválasztásával és a legjobb elrendezés és a megfelelő üzleti logika meghatározásával lefedi az előtérbeli felhasználói élményt.

A kimenet finomításához megtekintheti és szerkesztheti a létrehozott kódot. Az adatműveletek olyan objektumot dataApi használnak, amely a következő nyilvános metódusokat teszi elérhetővé:

Metódus Description
createRow Új sort hoz létre a megadott táblában.
updateRow Frissíti a megadott tábla egy meglévő sorát.
deleteRow Töröl egy sort a megadott táblából.
retrieveRow Beolvas egy sort a megadott táblából a megadott beállításokkal.
queryTable Lekérdez egy táblát a megadott beállításokkal.
getChoices Lekéri a megadott választási lehetőségek oszlopának nevét.

createRow módszer

Új sort hoz létre a megadott táblában.

Paraméterek

Adja meg ezeknek a szükséges paramétereknek az értékeit.

Név Típus Description
tableName karakterlánc A sor létrehozásához a tábla logikai neve.
row objektum A létrehozandó soradatok.

Visszatérítések

A művelet eredményét tartalmazó ígéret . Ha a művelet sikeres, az eredmény a létrehozott sor azonosítójának (GUID) értéke.

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

updateRow módszer

Frissíti a megadott tábla egy meglévő sorát.

Paraméterek

Adja meg ezeknek a szükséges paramétereknek az értékeit.

Név Típus Description
tableName karakterlánc A tábla logikai neve a sor frissítéséhez.
rowId karakterlánc A frissíteni kívánt sor azonosítója.
row Objektum A frissíteni kívánt soradatok.

Visszatérítések

A művelet eredményét tartalmazó ígéret . Ha a művelet sikeres, nem ad vissza értéket.

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

deleteRow módszer

Töröl egy sort a megadott táblából.

Paraméterek

Adja meg ezeknek a szükséges paramétereknek az értékeit.

Név Típus Description
tableName karakterlánc A sor törlésére kijelölt tábla logikai neve.
rowId karakterlánc A törölni kívánt sor azonosítója.

Visszatérítések

A művelet eredményét tartalmazó ígéret . Ha a művelet sikeres, nem ad vissza értéket.

Example

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

retrieveRow módszer

A megadott beállításokkal lekéri a sort a megadott táblából.

Paraméterek

Adja meg ezeknek a szükséges paramétereknek az értékeit.

Név Típus Description
tableName string A lekérni kívánt tábla logikai neve
options RetrieveRowOptions A sor beolvasásának lehetőségei

RetrieveRowOptions

Név Típus Description
id string A lekérendő sor azonosítója (Guid)
select string[] (Ajánlott) A lekérendő oszlopnevek tömbje. Ha nincs megadva, a rendszer az összes oszlopot visszaadja.

Visszatérítések

A művelet eredményét tartalmazó ígéret . Ha a művelet sikeres, a rendszer visszaad egy objektumot, amely a rekord adatait tartalmazza, beleértve az összes kijelölt oszlopot is.

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

queryTable módszer

A megadott beállításokkal lekérdez egy táblát.

Paraméterek

Adja meg ezeknek a szükséges paramétereknek az értékeit.

Név Típus Description
tableName string A lekérdezendő tábla logikai neve
query QueryTableOptions A tábla lekérdezésének beállításai

QueryTableOptions

Név Típus Description
select string[] (Ajánlott) A lekérendő oszlopnevek tömbje.
filter string (Nem kötelező) OData szűrőkifejezés (például statecode eq 0).
orderBy string (Nem kötelező) OData orderby kifejezés (például name asc, createdon desc).
pageSize number (Nem kötelező) Az oldalonként visszaadandó sorok maximális száma.

Visszatérítések

A művelet eredményét tartalmazó ígéret . Ha a művelet sikeres, az ígéret egy adattáblát tartalmazó objektumot ad vissza az alábbi tulajdonságokkal:

Név Típus Description
rows Object[] Soradatok tömbje
hasMoreRows boolean Azt jelzi, hogy több sor áll-e rendelkezésre
loadMoreRows function Függvény az eredmények következő oldalának betöltéséhez. (Választható)

Example

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

Megjegyzések

Megjegyzés:

A legjobb teljesítmény érdekében mindig korlátozza a QueryTableOptionsselect tulajdonság használatával visszaadott oszlopok számát.

getChoices módszer

Lekéri a megadott választási lehetőségek oszlopának nevét.

Paraméterek

Ez a paraméter kötelező.

Név Típus Description
enumName string A választott oszlop neve a formátumban tablename-columnname

Visszatérítések

A művelet eredményét tartalmazó ígéret . Ha a művelet sikeres, a választott lehetőségek tömbje lesz visszaadva. Mindegyik beállítás a következő tulajdonságokkal rendelkezik:

Név Típus Description
label karakterlánc A beállítás honosított címkeértéke.
value szám A beállítás numerikus értéke.

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