Andmeversi toiming ja funktsioonimeetodid generatiivsete lehtede jaoks

Kasutage lehega seotud Dataverse'i kohandatud API-de kutsumiseks objekti toimingu- ja funktsioonimeetodeiddataApi.

Märkus.

Tegevus- ja funktsioonimeetodid on ühislepingus dataApi valikulised. Mõned hostid ei juuruta neid, seega kontrollige enne kutsumist, kas mõni meetod on olemas. Kasutatav meetod ei tähenda, et toiming on lehega seotud, käitusaja jaoks lubatud või praeguse kasutaja jaoks lubatud. Erinevalt konnektori meetoditest ei visata neid meetodeid kunagi oodatud tõrgete korral; need lahendatakse tõrkekoodiga ok: false . Tulemite ok ja error atribuutide konkreetselt käsitlemine.

listBoundActions tagastab toimingud ja funktsioonid, mida praegune käitusaja konfiguratsioon lehe jaoks võimaldab, kui see tuvastamine on lubatud; see ei taga, et praegusel kasutajal on iga loetletud toimingu käivitamiseks vajalikud andmesideteenuse õigused.

Meetod	Kirjeldus
executeAction	Käivitab toiminguna lehega seotud Dataverse'i kohandatud API.
executeFunction	Käivitab funktsioonina lehega seotud Dataverse'i kohandatud API.
listBoundActions	Siin on loetletud lehega seotud kohandatud API-d Dataverse (Dataverse custom API) (toimingud ja funktsioonid).

executeAction Meetod

Käivitab dataverse custom API, mille looja on lehega seotud toiminguna (teade, mis võib andmeid muuta).

Parameetrid

Määrake selle nõutava parameetri väärtus.

Nimi	Tüüp	Kirjeldus
request	DataverseActionRequest	Kutsutav toiming ja selle sisendparameetrid.

DataverseActionRequest

Nimi	Tüüp	Kirjeldus
name	string	Kohandatud API kordumatu nimi (väljaandja eesliide), nt new_ApproveExpenseReport.
parameters	object	(Valikuline) Toimingu nõutavad sisendparameetrid, mis on võtmena esitatud parameetri kordumatu nime järgi.
boundTo	object	(Valikuline) Olemiga seotud toimingute sihtreaviide (entityName ja id). Globaalsete (sidumata) toimingute ärajätmine.

Tagastused

DataverseActionResult sisaldav lubadus. Seda meetodit ei kuvata kunagi eeldatud tõrgete korral (nt 403 õiguste tõrge, 400 vigane parameeter või toiming, mida ei saa siduda ega lubada) – kontrollige selle asemel atribuuti ok .

DataverseActionResult

Nimi	Tüüp	Kirjeldus
ok	boolean	Näitab, kas toiming õnnestus.
status	number	Dataverse'i tagastatud HTTP-oleku kood või 0 kui HTTP-olek pole saadaval. Olek 0 võib tähendada, et käitusaeg hüljas kõne enne selle saatmist (nt not_enabled, , not_permittednot_boundwrong_operation_kind, , invalid_parameter, või invalid_bound_to), taotlus nurjus ilma HTTP-vastuseta või tulemus on tundmatu (indeterminate on ).true Kasutage error.code neid juhtumeid eraldi.indeterminate
outputs	object	Toimingu tagastatud väljundparameetrid, võtmega kordumatu nimi. Tühi väljunditeta toimingute jaoks.
indeterminate	boolean	(Valikuline) true kui ajalõpp või mõni muu lähetusjärgne tõrge tähendab, et server võis toimingu sooritada; ära proovi automaatselt uuesti.
error	object	(Valikuline) Tõrke üksikasjad , kui ok on false, sh masinloetav code ja desinfitseeritud message. codeon üks , not_enabled, not_bound, not_permittedwrong_operation_kind, invalid_parameter, invalid_bound_to, , indeterminatevõi , või networktoimingu HTTP olekukood stringina (nt "404") kui Dataverse tagastas tõrkevastuse või "0" kui HTTP-olek polnud saadaval. not_permitted tähendab, et toiming või funktsioon pole keskkonna lubatud lehtede loendis – see ei näita, kas praegusel kasutajal on selle käitamiseks andmehalduri õigused. Õiguste tõrge ilmneb tavaliselt nagu status: 403 tõrkekoodi "403"korral; kui host ei saa HTTP-olekut määratleda, tagastab see selle asemel.status: 0

executeAction example

if (!dataApi.executeAction) {
  throw new Error("executeAction isn't available on this page.");
}

const result = await dataApi.executeAction({
  name: "new_ApproveExpenseReport",
  parameters: { comments: "Approved by manager" },
  boundTo: { entityName: "new_expensereport", id: "30dc51e9-947d-47d8-ad48-4fc48fba4a95" },
});

if (result.ok) {
  console.log(result.outputs);
}
else {
  console.log(result.error?.code);
}

executeFunction Meetod

Käivitab Dataverse'i kohandatud API, mille looja on lehega seotud funktsioonina (GET semantikaga kirjutuskaitstud sõnum).

Parameetrid

Määrake selle nõutava parameetri väärtus.

Nimi	Tüüp	Kirjeldus
request	DataverseFunctionRequest	Kutsutav funktsioon ja selle sisendparameetrid.

DataverseFunctionRequest

Nimi	Tüüp	Kirjeldus
name	string	Kohandatud API kordumatu nimi (väljaandja eesliide), nt new_GetExchangeRate.
parameters	object	(Valikuline) Funktsiooni nõutavad sisendparameetrid, mis on võtmena esitatud parameetri kordumatu nime järgi.
boundTo	object	(Valikuline) Olemiga seotud funktsioonide sihtreaviide (entityName ja id). Globaalsete (sidumata) funktsioonide väljajätmine.

Tagastused

DataverseActionResult sisaldav lubadus. Nagu ka executeActionselle puhul, ei esine see meetod oodatud tõrgete korral kunagi – kontrollige selle asemel atribuuti ok .

executeFunction example

if (!dataApi.executeFunction) {
  throw new Error("executeFunction isn't available on this page.");
}

const result = await dataApi.executeFunction({
  name: "new_GetExchangeRate",
  parameters: { currencyCode: "EUR" },
});

if (result.ok) {
  console.log(result.outputs);
}

listBoundActions Meetod

Siin on loetletud dataverse custom API-d (toimingud ja funktsioonid), mille looja on lehega seotud.

Parameetrid

Puudub.

Tagastused

Lubadus, mis sisaldab andmeverseActionInfo kirjete massiivi. Tagastab tühja massiivi, kui tuvastamine pole käitusaja jaoks lubatud.

DataverseActionInfo

DataverseActionInfo kajastab lehe looja seotud teavet selle toimingu või funktsiooni, mitte reaalajas andmevaatluste metaandmete kohta. Ärge kasutage seda sisestusvormide koostamiseks ega väljundite valideerimiseks – kontrollige parameetrinõudeid ja väljundkujundeid tegeliku Dataverse'i kohandatud API määratluse suhtes.

Nimi	Tüüp	Kirjeldus
name	string	Dataverse'i kohandatud API kordumatu (loogiline) nimi.
displayName	string	Kohandatud API kuvatav nimi.
isFunction	boolean	true kui Dataverse'i kohandatud API on funktsioon (kirjutuskaitstud); false kui tegu on toiminguga, sh siis, kui seda väärtust sidumise ajal ei salvestatud.
bindingType	string	Sidumistüüp: "Global" või "Entity".
boundEntityLogicalName	string	(Valikuline) Tabel, mille toimingu või funktsiooniga on seotud , kui bindingType see on "Entity".
parameters	Object[]	Sisendparameetrid, mis salvestati, kui Dataverse'i kohandatud API oli seotud lehega, igaüks a name ja .declaredKind type on alati "unknown" ja optional on alati false – kumbki ei kajasta Dataverse'i kohandatud API tegelikke metaandmeid.
outputs	Object[]	Alati tühi massiiv. Sidumistuvastus ei salvesta väljundparameetreid.

listBoundActions näide

const actions = await dataApi.listBoundActions?.();