dataApi reference for generative pages (Dokumentacja interfejsu dataApi dla stron generowania)

Podczas generowania strony przy użyciu języka naturalnego sztuczna inteligencja tworzy stronę React w języku TypeScript. Wygenerowana strona obejmuje zarówno środowisko użytkownika frontonu, wybierając odpowiednie składniki, jak i określając najlepszy układ oraz odpowiednią logikę biznesową.

Możesz wyświetlić i edytować wygenerowany kod, aby uściślić dane wyjściowe. Operacje na danych używają dataApi obiektu, który uwidacznia następujące metody publiczne:

Metoda	Description
createRow	Tworzy nowy wiersz w określonej tabeli.
updateRow	Aktualizuje istniejący wiersz w określonej tabeli.
deleteRow	Usuwa wiersz z określonej tabeli.
retrieveRow	Pobiera wiersz z określonej tabeli z określonymi opcjami.
queryTable	Wysyła zapytanie do tabeli z określonymi opcjami.
getChoices	Pobiera opcje dla określonej nazwy kolumny wyboru.

Metoda createRow

Tworzy nowy wiersz w określonej tabeli.

Parametry

Ustaw wartości dla tych wymaganych parametrów.

Name	Typ	Description
tableName	ciąg	Logiczna nazwa tabeli do utworzenia wiersza.
row	obiekt	Dane wiersza do utworzenia.

Zwraca

Obietnica zawierająca wynik operacji. Po pomyślnym zakończeniu operacji wynik jest wartością identyfikatora (Guid) utworzonego wiersza.

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

Metoda updateRow

Aktualizuje istniejący wiersz w określonej tabeli.

Parametry

Ustaw wartości dla tych wymaganych parametrów.

Name	Typ	Description
tableName	ciąg	Logiczna nazwa tabeli do zaktualizowania wiersza.
rowId	ciąg	Identyfikator wiersza do zaktualizowania.
row	Object	Dane wierszy do zaktualizowania.

Zwraca

Obietnica zawierająca wynik operacji. Gdy operacja zakończy się pomyślnie, nie zwraca żadnej wartości.

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

Metoda deleteRow

Usuwa wiersz z określonej tabeli.

Parametry

Ustaw wartości dla tych wymaganych parametrów.

Name	Typ	Description
tableName	ciąg	Nazwa logiczna tabeli do usunięcia wiersza.
rowId	ciąg	Identyfikator wiersza do usunięcia.

Zwraca

Obietnica zawierająca wynik operacji. Gdy operacja zakończy się pomyślnie, nie zwraca żadnej wartości.

Example

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

Metoda retrieveRow

Pobiera wiersz z określonej tabeli przy użyciu określonych opcji.

Parametry

Ustaw wartości dla tych wymaganych parametrów.

Name	Typ	Description
tableName	string	Nazwa logiczna tabeli do pobrania z
options	RetrieveRowOptions	Opcje pobierania wiersza

RetrieveRowOptions

Name	Typ	Description
id	string	Identyfikator (Guid) wiersza do pobrania
select	string[]	(Zalecane) Tablica nazw kolumn do pobrania. W przypadku pominięcia zwracane są wszystkie kolumny.

Zwraca

Obietnica zawierająca wynik operacji. Po pomyślnym zakończeniu operacji zwracany jest obiekt zawierający dane rekordu, w tym wszystkie wybrane kolumny.

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

Metoda queryTable

Wykonuje zapytania dotyczące tabeli przy użyciu określonych opcji.

Parametry

Ustaw wartości dla tych wymaganych parametrów.

Name	Typ	Description
tableName	string	Nazwa logiczna tabeli do wykonywania zapytań
query	QueryTableOptions	Opcje wykonywania zapytań dotyczących tabeli

QueryTableOptions

Name	Typ	Description
select	string[]	(Zalecane) Tablica nazw kolumn do pobrania.
filter	string	(Opcjonalnie) Wyrażenie filtru OData (na przykład statecode eq 0).
orderBy	string	(Opcjonalnie) Wyrażenie orderby OData (na przykład name asc, createdon desc).
pageSize	number	(Opcjonalnie) Maksymalna liczba wierszy do zwrócenia na stronę.

Zwraca

Obietnica zawierająca wynik operacji. Po pomyślnym zakończeniu operacji obietnica zwraca obiekt zawierający tabelę danych z wynikami o następujących właściwościach:

Name	Typ	Description
rows	Object[]	Tablica danych wierszy
hasMoreRows	boolean	Wskazuje, czy jest dostępnych więcej wierszy
loadMoreRows	function	Funkcja ładowania następnej strony wyników. (Opcjonalnie)

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

Uwagi

Uwaga / Notatka

Aby uzyskać najlepszą wydajność, należy zawsze ograniczyć liczbę kolumn zwracanych przy użyciu właściwości QueryTableOptionsselect .

Metoda getChoices

Pobiera opcje dla określonej nazwy kolumny wyboru.

Parametry

Ten parametr jest wymagany.

Name	Typ	Description
enumName	string	Nazwa wybranej kolumny w formacie tablename-columnname

Zwraca

Obietnica zawierająca wynik operacji. Gdy operacja zakończy się pomyślnie, zwraca tablicę opcji wyboru. Każda opcja ma następujące właściwości:

Name	Typ	Description
label	ciąg	Zlokalizowana wartość etykiety opcji.
value	liczba	Wartość liczbowa opcji.

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