Dataverse-Tabellenmethoden für generative Seiten

Verwenden Sie die Tabellenmethoden des dataApi Objekts, um Dataverse-Tabellenzeilen und Abfrageauswahlspalten zu erstellen, abzurufen, zu aktualisieren und zu löschen.

Methode Description
createRow Erstellt eine neue Zeile in der angegebenen Tabelle.
deleteRow Löscht eine Zeile aus der angegebenen Tabelle.
getChoices Ruft die Auswahlmöglichkeiten für den angegebenen Auswahlspaltennamen ab.
queryTable Fragt eine Tabelle mit den angegebenen Optionen ab.
retrieveRow Ruft eine Zeile aus der angegebenen Tabelle mit den angegebenen Optionen ab.
updateRow Aktualisiert eine vorhandene Zeile in der angegebenen Tabelle.

createRow Methode

Erstellt eine neue Zeile in der angegebenen Tabelle.

Parameters

Legen Sie Werte für diese erforderlichen Parameter fest.

Name Type Description
tableName string Der logische Name der Tabelle, in der die Zeile erstellt werden soll.
row Objekt Die zu erstellenden Zeilendaten.

Rücklieferungen

Eine Zusage , die das Ergebnis des Vorgangs enthält. Wenn der Vorgang erfolgreich ist, entspricht das Ergebnis dem ID-Wert (GUID) der erstellten Zeile.

createRow-Beispiel

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

Löscht eine Zeile aus der angegebenen Tabelle.

Parameters

Legen Sie Werte für diese erforderlichen Parameter fest.

Name Type Description
tableName string Der logische Name der Tabelle, in der die Zeile gelöscht werden soll.
rowId string Die ID der zu löschenden Zeile.

Rücklieferungen

Eine Zusage , die das Ergebnis des Vorgangs enthält. Wenn der Vorgang erfolgreich ist, wird kein Wert zurückgegeben.

deleteRow-Beispiel

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

getChoices Methode

Ruft die Auswahlmöglichkeiten für den angegebenen Auswahlspaltennamen ab.

Parameters

Dieser Parameter ist erforderlich.

Name Type Description
enumName string Der Name der Auswahlspalte im Format tablename-columnname

Rücklieferungen

Eine Zusage , die das Ergebnis des Vorgangs enthält. Wenn der Vorgang erfolgreich ist, wird ein Array der Auswahloptionen zurückgegeben. Jede Option verfügt über die folgenden Eigenschaften:

Name Type Description
label string Der lokalisierte Bezeichnungswert der Option.
value Zahl Der numerische Wert der Option.

getChoices-Beispiel

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

Fragt eine Tabelle mithilfe der angegebenen Optionen ab.

Parameters

Legen Sie Werte für diese erforderlichen Parameter fest.

Name Type Description
tableName string Der logische Name der zu abfragenden Tabelle
query QueryTableOptions Optionen zum Abfragen der Tabelle

QueryTableOptions

Name Type Description
select string[] (Empfohlen) Array von Spaltennamen, die abgerufen werden sollen.
filter string (Optional) OData-Filterausdruck (z. B statecode eq 0. ).
orderBy string (Optional) OData orderby expression (for example, name asc, createdon desc).
pageSize number (Optional) Maximale Anzahl von Zeilen, die pro Seite zurückgegeben werden sollen.

Rücklieferungen

Eine Zusage , die das Ergebnis des Vorgangs enthält. Wenn der Vorgang erfolgreich verläuft, gibt die Zusage ein Objekt zurück, das eine Datentabelle mit den Ergebnissen mit den folgenden Eigenschaften enthält:

Name Type Description
rows Object[] Array von Zeilendaten
hasMoreRows boolean Gibt an, ob weitere Zeilen verfügbar sind.
loadMoreRows function Funktion zum Laden der nächsten Seite der Ergebnisse. (Optional)

QueryTable-Beispiel

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

Hinweis

Um eine optimale Leistung zu erzielen, beschränken Sie immer die Anzahl der spalten, die mithilfe der QueryTableOptions-Eigenschaftselect zurückgegeben werden.

retrieveRow Methode

Ruft eine Zeile aus der angegebenen Tabelle mithilfe der angegebenen Optionen ab.

Parameters

Legen Sie Werte für diese erforderlichen Parameter fest.

Name Type Description
tableName string Der logische Name der Tabelle, aus der abgerufen werden soll
options RetrieveRowOptions Optionen zum Abrufen der Zeile

RetrieveRowOptions

Name Type Description
id string Die ID (GUID) der abzurufenden Zeile
select string[] (Empfohlen) Array von Spaltennamen, die abgerufen werden sollen. Wenn sie weggelassen wird, werden alle Spalten zurückgegeben.

Rücklieferungen

Eine Zusage , die das Ergebnis des Vorgangs enthält. Wenn der Vorgang erfolgreich verläuft, wird ein Objekt mit den Datensatzdaten einschließlich aller ausgewählten Spalten zurückgegeben.

retrieveRow-Beispiel

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

Aktualisiert eine vorhandene Zeile in der angegebenen Tabelle.

Parameters

Legen Sie Werte für diese erforderlichen Parameter fest.

Name Type Description
tableName string Der logische Name der Tabelle, in der die Zeile aktualisiert werden soll.
rowId string Die ID der zu aktualisierenden Zeile.
row Object Die zu aktualisierenden Zeilendaten.

Rücklieferungen

Eine Zusage , die das Ergebnis des Vorgangs enthält. Wenn der Vorgang erfolgreich ist, wird kein Wert zurückgegeben.

updateRow-Beispiel

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