Notatka
Dostęp do tej strony wymaga autoryzacji. Może spróbować zalogować się lub zmienić katalogi.
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować zmienić katalogi.
Metody tabeli dataApi obiektu umożliwiają tworzenie, pobieranie, aktualizowanie i usuwanie wierszy tabeli Dataverse oraz wykonywanie zapytań dotyczących kolumn wyboru.
| Metoda | Description |
|---|---|
createRow |
Tworzy nowy wiersz w określonej tabeli. |
deleteRow |
Usuwa wiersz z określonej tabeli. |
getChoices |
Pobiera opcje dla określonej nazwy kolumny wyboru. |
queryTable |
Wysyła zapytanie do tabeli z określonymi opcjami. |
retrieveRow |
Pobiera wiersz z określonej tabeli z określonymi opcjami. |
updateRow |
Aktualizuje istniejący wiersz w określonej tabeli. |
Metoda createRow
Tworzy nowy wiersz w określonej tabeli.
Parameters
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. |
Returns
Obietnica zawierająca wynik operacji. Po pomyślnym zakończeniu operacji wynik jest wartością identyfikatora (Guid) utworzonego wiersza.
przykład createRow
// 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 deleteRow
Usuwa wiersz z określonej tabeli.
Parameters
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. |
Returns
Obietnica zawierająca wynik operacji. Gdy operacja zakończy się pomyślnie, nie zwraca żadnej wartości.
deleteRow — przykład
let rowId = "5531d753-95af-e711-a94e-000d3a11e605";
try {
await dataApi.deleteRow("account", rowId);
}
catch (error) {
console.log(error.message);
}
Metoda getChoices
Pobiera opcje dla określonej nazwy kolumny wyboru.
Parameters
Ten parametr jest wymagany.
| Name | Typ | Description |
|---|---|---|
enumName |
string |
Nazwa wybranej kolumny w formacie tablename-columnname |
Returns
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 |
number | Wartość liczbowa opcji. |
przykład getChoices
// 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');
Metoda queryTable
Wykonuje zapytania dotyczące tabeli przy użyciu określonych opcji.
Parameters
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ę. |
Returns
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) |
przykład tabeli queryTable
// 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`);
}
Remarks
Uwaga / Notatka
Aby uzyskać najlepszą wydajność, należy zawsze ograniczyć liczbę kolumn zwracanych przy użyciu właściwości QueryTableOptionsselect .
Metoda retrieveRow
Pobiera wiersz z określonej tabeli przy użyciu określonych opcji.
Parameters
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. |
Returns
Obietnica zawierająca wynik operacji. Gdy operacja zakończy się pomyślnie, zwraca obiekt z danymi rekordu, w tym wszystkie wybrane kolumny.
przykład pobieraniaRow
// 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 updateRow
Aktualizuje istniejący wiersz w określonej tabeli.
Parameters
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. |
Returns
Obietnica zawierająca wynik operacji. Gdy operacja zakończy się pomyślnie, nie zwraca żadnej wartości.
updateRow — przykład
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);
}