Metódy akcie a funkcie Dataverse pre generatívne stránky

Pomocou metód dataApi akcie a funkcie objektu vyvolajte vlastné rozhrania API Dataverse viazané na stranu.

Note

Metódy akcie a funkcie sú v zdieľanej dataApi zmluve voliteľné. Niektorí hostitelia ich neimplementujú, takže pred volaním skontrolujte, či existuje metóda. Prítomná metóda neznamená, že operácia je viazaná na stránku, povolená pre modul runtime alebo povolená pre aktuálneho používateľa. Na rozdiel od metód konektora, tieto metódy nikdy hádzať pre očakávané zlyhania; vyriešia problém s ok: false kódom chyby a namiesto toho aj kód chyby. Spracujte výsledky ok a error vlastnosti explicitne.

listBoundActions vráti akcie a funkcie, ktoré aktuálna konfigurácia režimu runtime umožňuje stránke, keď je tento objav povolený; nie je zárukou, že aktuálny používateľ bude obsahovať oprávnenia služby Dataverse potrebné na vykonanie každej uvedenej operácie.

Metóda Description
executeAction Vyvolá vlastné rozhranie API služby Dataverse viazané na stránku ako akciu.
executeFunction Vyvolá vlastné rozhranie API služby Dataverse viazané na stránku ako funkciu.
listBoundActions Zoznam vlastných rozhraní API dataverse (akcií a funkcií) naviazaných na stranu.

executeAction metóda

Vyvolá vlastné rozhranie API Dataverse, ktoré tvorca naviazaný na stránku vyvolá ako akciu (hlásenie, ktoré môže zmeniť údaje).

Parametre

Nastavte hodnotu pre tento povinný parameter.

Name Type Description
request DataverseActionRequest Akcia, ktorá sa má vyvolať, a jej vstupné parametre.

DataverseActionRequest

Name Type Description
name string Jedinečný názov vlastného rozhrania API s predponou vydavateľa, ako new_ApproveExpenseReportnapríklad .
parameters object (Voliteľné) Vstupné parametre vyžadované akciou, kľúčom podľa jedinečného názvu parametra.
boundTo object (Voliteľné) Odkaz na cieľový riadok (entityName a id) pre akcie viazané na entitu. V prípade globálnych akcií (bez obmedzenia) vynecháte.

Vrátené hodnoty

Sľub obsahujúci dataverseActionResult. Táto metóda nikdy nevyhádže očakávané zlyhania (napríklad chyba povolenia 403, 400 chybných parametrov alebo operácia, ktorá nie je viazaná alebo povolená) – skontrolujte ok vlastnosť namiesto toho.

DataverseActionResult

Name Type Description
ok boolean Udáva, či bola akcia úspešná.
status number Kód stavu HTTP vrátený funkciou Dataverse alebo 0 v prípade, že nie je k dispozícii žiadny stav HTTP. Stav 0 môže znamenať, že volanie runtime bolo zamietnuté pred odoslaním (napríklad not_enabled, , not_bound, not_permitted, wrong_operation_kind, invalid_parameteralebo invalid_bound_to), žiadosť zlyhala bez odpovede HTTP, alebo výsledok nie je známy (indeterminate is true). Použite error.code a indeterminate rozoznajte tieto prípady od seba.
outputs object Výstupné parametre vrátené akciou, kľúčom podľa jedinečného názvu. Prázdna hodnota pre akcie bez výstupov.
indeterminate boolean (Voliteľné) true ak časový limit alebo iná porucha po odoslaní znamená, že server mohol vykonať akciu; Neskúsiť automaticky.
error object (Voliteľné) Podrobnosti o chybe, kedy ok je false, vrátane strojovo čitateľnej code a dezinfikovanej položky message. codeje jeden z kódov not_enabledstavu , , not_bound, wrong_operation_kindnot_permitted, invalid_bound_toinvalid_parameter, indeterminatealebo networkalebo kód stavu akcie HTTP ako reťazec (napríklad "404"), keď funkcia Dataverse vrátila chybovú odpoveď alebo "0" keď nebol k dispozícii žiadny stav HTTP. not_permitted Akcia alebo funkcia nie je v zozname povolených prostredí pre generatatívne stránky – neuvádza, či aktuálny používateľ má oprávnenia Dataverse na jej spustenie. Zlyhanie oprávnenia sa zvyčajne zobrazuje ako status: 403 zlyhanie pomocou kódu "403"chyby. Ak hostiteľ nedokáže určiť stav HTTP, vráti sa status: 0 namiesto toho.

príklad vykonania príkazu

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 metóda

Vyvolá vlastné rozhranie API Dataverse, ktoré tvorca naviazaný na stránku vyvolá ako funkciu (správa iba na čítanie so sémantikou GET).

Parametre

Nastavte hodnotu pre tento povinný parameter.

Name Type Description
request DataverseFunctionRequest Funkcia, ktorá sa má vyvolať, a jej vstupné parametre.

DataverseFunctionRequest

Name Type Description
name string Jedinečný názov vlastného rozhrania API s predponou vydavateľa, ako new_GetExchangeRatenapríklad .
parameters object (Voliteľné) Vstupné parametre vyžadované funkciou, kľúčom podľa jedinečného názvu parametra.
boundTo object (Voliteľné) Odkaz na cieľový riadok (entityName a id) pre funkcie viazané na entitu. V prípade globálnych (nespájaných) funkcií vynecháte.

Vrátené hodnoty

Sľub obsahujúci dataverseActionResult. Podobne ako pri metóde executeAction, táto metóda nikdy nevyhádže očakávané zlyhania – namiesto toho skontrolujte ok vlastnosť .

Príklad funkcie executeFunction

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 metóda

Uvádza zoznam vlastných rozhraní API dataverse (akcií a funkcií), ktoré tvorca naviazaný na stranu.

Parametre

None.

Vrátené hodnoty

Sľub obsahujúci pole položiek DataverseActionInfo. Vráti prázdne pole v prípade, že zisťovanie nie je povolené pre modul runtime.

DataverseActionInfo

DataverseActionInfo Prvok vyjadruje, na čo je tvorca stránky viazaný na túto akciu alebo funkciu, nie dynamické metaúdaje Dataverse. Nepoužívajte ju na vytváranie vstupných formulárov ani na overenie výstupov – overte požiadavky parametrov a výstupné tvary v porovnaní so skutočnou vlastnou definíciou rozhrania API Dataverse.

Name Type Description
name string Jedinečný (logický) názov vlastného rozhrania API Dataverse.
displayName string Zobrazovaný názov vlastného rozhrania API.
isFunction boolean true ak je vlastné rozhranie API Dataverse funkciou (iba na čítanie), false ak ide o akciu, a to aj vtedy, keď táto hodnota nebola zaznamenaná v čase viazania.
bindingType string Typ väzby: "Global" alebo "Entity".
boundEntityLogicalName string (Voliteľné) Tabuľka, na ktoré sa akcia alebo funkcia viaže, keď bindingType je "Entity".
parameters Object[] Vstupné parametre zaznamenané, keď bolo vlastné rozhranie API Dataverse viazané na stranu, pričom každé z nich bolo a namedeclaredKind. type je vždy "unknown" a optional je vždy false – žiadne neodráža skutočné metaúdaje vlastného rozhrania API Dataverse.
outputs Object[] Vždy prázdne pole. Zisťovanie väzieb nezaznauje výstupné parametre.

listBoundActions príklad

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