Dataverse-tabellmetoder för generativa sidor

Använd tabellmetoderna för dataApi objektet för att skapa, hämta, uppdatera och ta bort Dataverse-tabellrader och frågevalskolumner.

Method Description
createRow Skapar en ny rad i den angivna tabellen.
deleteRow Tar bort en rad från den angivna tabellen.
getChoices Hämtar alternativen för det angivna valkolumnnamnet.
queryTable Frågar en tabell med de angivna alternativen.
retrieveRow Hämtar en rad från den angivna tabellen med de angivna alternativen.
updateRow Uppdaterar en befintlig rad i den angivna tabellen.

createRow metod

Skapar en ny rad i den angivna tabellen.

Parameters

Ange värden för dessa obligatoriska parametrar.

Name Type Description
tableName string Det logiska namnet på tabellen som raden ska skapas i.
row object Raddata som ska skapas.

Returns

Ett löfte som innehåller resultatet av åtgärden. När åtgärden lyckas blir resultatet ID-värdet (Guid) för den skapade raden.

createRow-exempel

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

Tar bort en rad från den angivna tabellen.

Parameters

Ange värden för dessa obligatoriska parametrar.

Name Type Description
tableName string Det logiska namnet på tabellen som raden ska tas bort i.
rowId string ID:t för raden som ska tas bort.

Returns

Ett löfte som innehåller resultatet av åtgärden. När åtgärden lyckas returneras inget värde.

deleteRow-exempel

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

getChoices metod

Hämtar alternativen för det angivna valkolumnnamnet.

Parameters

Den här parametern krävs.

Name Type Description
enumName string Namnet på valfri kolumn i formatet tablename-columnname

Returns

Ett löfte som innehåller resultatet av åtgärden. När åtgärden lyckas returneras en matris med alternativ. Varje alternativ har följande egenskaper:

Name Type Description
label string Alternativets lokaliserade etikettvärde.
value number Alternativets numeriska värde.

getChoices-exempel

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

Frågar en tabell med hjälp av de angivna alternativen.

Parameters

Ange värden för dessa obligatoriska parametrar.

Name Type Description
tableName string Det logiska namnet på tabellen som ska frågas
query QueryTableOptions Alternativ för att fråga tabellen

QueryTableOptions

Name Type Description
select string[] (Rekommenderas) Matris med kolumnnamn som ska hämtas.
filter string (Valfritt) OData-filteruttryck (till exempel statecode eq 0).
orderBy string (Valfritt) OData orderby-uttryck (till exempel name asc, createdon desc).
pageSize number (Valfritt) Maximalt antal rader som ska returneras per sida.

Returns

Ett löfte som innehåller resultatet av åtgärden. När åtgärden lyckas returnerar löftet ett objekt som innehåller en datatabell med resultatet med följande egenskaper:

Name Type Description
rows Object[] Matris med raddata
hasMoreRows boolean Anger om det finns fler rader tillgängliga
loadMoreRows function Funktion för att läsa in nästa sida med resultat. (Valfritt)

queryTable-exempel

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

Note

För bästa prestanda begränsar du alltid antalet kolumner som returneras med egenskapen QueryTableOptionsselect .

retrieveRow metod

Hämtar en rad från den angivna tabellen med hjälp av de angivna alternativen.

Parameters

Ange värden för dessa obligatoriska parametrar.

Name Type Description
tableName string Det logiska namnet på tabellen som ska hämtas från
options RetrieveRowOptions Alternativ för att hämta raden

RetrieveRowOptions

Name Type Description
id string ID:t (Guid) för raden som ska hämtas
select string[] (Rekommenderas) Matris med kolumnnamn som ska hämtas. Om det utelämnas returneras alla kolumner.

Returns

Ett löfte som innehåller resultatet av åtgärden. När åtgärden lyckas returneras ett objekt med postdata, inklusive alla markerade kolumner.

retrieveRow-exempel

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

Uppdaterar en befintlig rad i den angivna tabellen.

Parameters

Ange värden för dessa obligatoriska parametrar.

Name Type Description
tableName string Det logiska namnet på tabellen som raden ska uppdateras i.
rowId string ID:t för raden som ska uppdateras.
row Object Raddata som ska uppdateras.

Returns

Ett löfte som innehåller resultatet av åtgärden. När åtgärden lyckas returneras inget värde.

updateRow-exempel

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