Dataverse-taulukkomenetelmät luoville sivuille

Luo, nouda, päivitä ja poista Dataverse-taulukon rivejä ja kyselyn valintasarakkeita objektin dataApi taulukkomenetelmillä.

Menetelmä Kuvaus
createRow Luo uuden rivin määritettyyn taulukkoon.
deleteRow Poistaa rivin määritetystä taulukosta.
getChoices Hakee määritetyn vaihtoehdon sarakkeen nimen vaihtoehdot.
queryTable Tekee kyselyn määritettyjä asetuksia sisältävään taulukkoon.
retrieveRow Hakee määritetystä taulukosta rivin, joka sisältää määritetyt asetukset.
updateRow Päivittää määritetyn taulukon olemassa olevan rivin.

createRow menetelmä

Luo uuden rivin määritettyyn taulukkoon.

Parametrit

Määritä näiden pakollisten parametrien arvot.

Nimi Kirjoita Kuvaus
tableName merkkijono Sen taulukon looginen nimi, johon rivi luodaan.
row objekti Luotavat rivitiedot.

Palautukset

Lupaus, joka sisältää operaation tuloksen. Kun toiminto onnistuu, tuloksena on luodun rivin TUNNUS (GUID) -arvo.

createRow-esimerkki

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

Poistaa rivin määritetystä taulukosta.

Parametrit

Määritä näiden pakollisten parametrien arvot.

Nimi Kirjoita Kuvaus
tableName merkkijono Sen taulukon looginen nimi, johon rivi poistetaan.
rowId merkkijono Poistettavan rivin tunnus.

Palautukset

Lupaus, joka sisältää operaation tuloksen. Kun toiminto onnistuu, se ei palauta arvoa.

esimerkki deleteRow

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

getChoices menetelmä

Hakee määritetyn vaihtoehdon sarakkeen nimen vaihtoehdot.

Parametrit

Tämä parametri vaaditaan.

Nimi Kirjoita Kuvaus
enumName string Valintasarakkeen nimi muodossa tablename-columnname

Palautukset

Lupaus, joka sisältää operaation tuloksen. Kun toiminto onnistuu, se palauttaa valinta-asetusten matriisin. Kullakin asetuksella on seuraavat ominaisuudet:

Nimi Kirjoita Kuvaus
label merkkijono Asetuksen lokalisoitu selitearvo.
value numero Asetuksen numeerinen arvo.

esimerkki getChoices-hausta

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

Tekee kyselyjä taulukosta käyttämällä määritettyjä asetuksia.

Parametrit

Määritä näiden pakollisten parametrien arvot.

Nimi Kirjoita Kuvaus
tableName string Kyselyn sisältävän taulukon looginen nimi
query QueryTableOptions Kyselyn tekeminen taulukosta

QueryTableOptions

Nimi Kirjoita Kuvaus
select string[] (Suositus) Noudettava sarakenimien matriisi.
filter string (Valinnainen) OData-suodatinlauseke (esimerkiksi statecode eq 0).
orderBy string (Valinnainen) OData orderby -lauseke (esimerkiksi name asc, createdon desc).
pageSize number (Valinnainen) Sivulla palautettavien rivien enimmäismäärä.

Palautukset

Lupaus, joka sisältää operaation tuloksen. Kun toiminto onnistuu, lupaus palauttaa objektin, joka sisältää tietotaulukon, joka sisältää tulokset seuraavilla ominaisuuksilla:

Nimi Kirjoita Kuvaus
rows Object[] Rivitietojen matriisi
hasMoreRows boolean Ilmaisee, onko käytettävissä enemmän rivejä
loadMoreRows function Funktio, joka lataa seuraavan tulossivun. (Valinnainen)

queryTable-esimerkki

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

Huomautuksia

Note

Parhaan suorituskyvyn takaaminen rajoita aina palautettujen sarakkeiden määrää Käyttämällä QueryTableOptions-ominaisuuttaselect .

retrieveRow menetelmä

Hakee rivin määritetystä taulukosta käyttämällä määritettyjä asetuksia.

Parametrit

Määritä näiden pakollisten parametrien arvot.

Nimi Kirjoita Kuvaus
tableName string Kohteesta noudettavan taulukon looginen nimi
options Hae riviasetukset Vaihtoehdot rivin noutamiseen

Hae riviasetukset

Nimi Kirjoita Kuvaus
id string Noudettavan rivin tunnus (GUID)
select string[] (Suositus) Noudettava sarakenimien matriisi. Jos tämä jätetään pois, kaikki sarakkeet palautetaan.

Palautukset

Lupaus, joka sisältää operaation tuloksen. Kun toiminto onnistuu, se palauttaa objektin, joka sisältää tietuetiedot kaikki valitut sarakkeet mukaan lukien.

esimerkki retrieveRow

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

Päivittää määritetyn taulukon olemassa olevan rivin.

Parametrit

Määritä näiden pakollisten parametrien arvot.

Nimi Kirjoita Kuvaus
tableName merkkijono Sen taulukon looginen nimi, johon rivi päivitetään.
rowId merkkijono Päivitettävän rivin tunnus.
row Objekti Päivitettävät rivitiedot.

Palautukset

Lupaus, joka sisältää operaation tuloksen. Kun toiminto onnistuu, se ei palauta arvoa.

updateRow-esimerkki

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