dataApi reference for generative pages

בעת יצירת דף באמצעות שפה טבעית, הבינה המלאכותית יוצרת דף React ב- TypeScript. הדף שנוצר מכסה הן את חוויית המשתמש החזיתית על-ידי בחירת הרכיבים המתאימים והן קביעה של הפריסה הטובה ביותר והלוגיקה העסקית המתאימה.

באפשרותך להציג ולערוך את הקוד שנוצר כדי למקד את הפלט. פעולות נתונים משתמשות באובייקט dataApi החושפת את השיטות הציבוריות הבאות:

פעולת שירות	תיאור
createRow	יצירת שורה חדשה בטבלה שצוינה.
updateRow	עדכון שורה קיימת בטבלה שצוינה.
deleteRow	מחיקת שורה מהטבלה שצוינה.
retrieveRow	אחזור שורה מהטבלה שצוינה עם האפשרויות שצוינו.
queryTable	שאילתה על טבלה עם האפשרויות שצוינו.
getChoices	מאחזר את האפשרויות עבור שם עמודת הבחירה שצוין.

createRow שיטת

יצירת שורה חדשה בטבלה שצוינה.

פרמטרים

הגדר ערכים עבור פרמטרים נדרשים אלה.

שם	סוג נתונים	תיאור
tableName	מחרוזת	השם הלוגי של הטבלה בה יש ליצור את השורה.
row	אובייקט	נתוני השורה ליצירה.

החזרות

הבטחה המכילה את תוצאת הפעולה. כאשר הפעולה מצליחה, התוצאה היא ערך המזהה (Guid) של השורה שנוצרה.

לדוגמה

// 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 שיטת

עדכון שורה קיימת בטבלה שצוינה.

פרמטרים

הגדר ערכים עבור פרמטרים נדרשים אלה.

שם	סוג נתונים	תיאור
tableName	מחרוזת	השם הלוגי של הטבלה לעדכון השורה.
rowId	מחרוזת	המזהה של השורה לעדכון.
row	אובייקט	נתוני השורה לעדכון.

החזרות

הבטחה המכילה את תוצאת הפעולה. כאשר הפעולה מצליחה, היא אינה מחזירה ערך.

לדוגמה

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 שיטת

מחיקת שורה מהטבלה שצוינה.

פרמטרים

הגדר ערכים עבור פרמטרים נדרשים אלה.

שם	סוג נתונים	תיאור
tableName	מחרוזת	השם הלוגי של הטבלה בה יש למחוק את השורה.
rowId	מחרוזת	המזהה של השורה למחיקה.

החזרות

הבטחה המכילה את תוצאת הפעולה. כאשר הפעולה מצליחה, היא אינה מחזירה ערך.

לדוגמה

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

retrieveRow שיטת

אחזור שורה מהטבלה שצוינה באמצעות האפשרויות שצוינו.

פרמטרים

הגדר ערכים עבור פרמטרים נדרשים אלה.

שם	סוג נתונים	תיאור
tableName	string	השם הלוגי של הטבלה שמה יש לאחזר
options	RetrieveRowOptions	אפשרויות לאחזור השורה

RetrieveRowOptions

שם	סוג נתונים	תיאור
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'],
});

queryTable שיטת

ביצוע שאילתה בטבלה באמצעות האפשרויות שצוינו.

פרמטרים

הגדר ערכים עבור פרמטרים נדרשים אלה.

שם	סוג נתונים	תיאור
tableName	string	השם הלוגי של הטבלה לשאילתה
query	טבלאות שאילתהאפשרויות	אפשרויות עבור ביצוע שאילתה בטבלה

טבלאות שאילתהאפשרויות

שם	סוג נתונים	תיאור
select	string[]	(מומלץ) מערך של שמות עמודות לאחזור.
filter	string	(אופציונלי) ביטוי מסנן OData (לדוגמה, statecode eq 0).
orderBy	string	(אופציונלי) OData orderby expression (לדוגמה, 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 .

getChoices שיטת

מאחזר את האפשרויות עבור שם עמודת הבחירה שצוין.

פרמטרים

פרמטר זה נדרש.

שם	סוג נתונים	תיאור
enumName	string	השם של עמודת הבחירה בתבנית tablename-columnname

החזרות

הבטחה המכילה את תוצאת הפעולה. כאשר הפעולה מצליחה, היא מחזירה מערך של אפשרויות הבחירה. לכל אפשרות יש מאפיינים אלה:

שם	סוג נתונים	תיאור
label	מחרוזת	ערך התווית המותאם לשפות אחרות של האפשרות.
value	מספר	הערך המספרי של האפשרות.

לדוגמה

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