Dataverse action and function methods for generative pages

Utilizați metodele de acțiune și funcție ale obiectului dataApi pentru a invoca API-uri particularizate legate la pagină.

Notă

Metodele de acțiune și de funcții sunt opționale în contractul partajat dataApi . Unele gazde nu le implementează, deci verificați dacă există o metodă înainte de a o apela. O metodă prezentă nu înseamnă că operațiunea este legată la pagină, activată pentru modulul runtime sau permisă pentru utilizatorul curent. Spre deosebire de metodele conectoare, aceste metode nu generează niciodată erori așteptate; acestea se rezolvă cu ok: false un cod de eroare și în schimb. ok Gestionați în mod explicit proprietățile și error rezultatele.

listBoundActions returnează acțiunile și funcțiile configurației runtime curente permite pagina atunci când descoperirea este activată; nu este o garanție că utilizatorul curent deține privilegiile Dataverse necesare pentru a executa fiecare operațiune listată.

Metodă Descriere
executeAction Apelează un API particularizat Dataverse legat la pagină ca acțiune.
executeFunction Apelează un API particularizat Dataverse legat la pagină ca funcție.
listBoundActions Listează API-urile particularizate (acțiuni și funcții) particularizate legate la pagină.

executeAction metodă

Apelează un API particularizat Dataverse legat la pagină ca acțiune (un mesaj care poate modifica datele).

Parametri

Setați o valoare pentru acest parametru obligatoriu.

Nume Tip Descriere
request DataverseActionRequest Acțiunea de invocare și parametrii săi de intrare.

DataverseActionRequest

Nume Tip Descriere
name string Numele unic al API-ului particularizat, prefixat de editor, cum new_ApproveExpenseReportar fi .
parameters object (Opțional) Parametrii de intrare necesari acțiunii, cheiați după numele unic al parametrului.
boundTo object (Opțional) O referință de rând țintă (entityName și id) pentru acțiunile legate de entitate. Omiteți acțiunile globale (nelegate).

Retururi

O promisiune care conține o DataverseActionResult. Această metodă nu generează niciodată erori așteptate (cum ar fi o eroare de permisiune 403, un parametru 400 greșit sau operațiunea care nu este legată sau activată) - verificați ok proprietatea în schimb.

DataverseActionResult

Nume Tip Descriere
ok boolean Indică dacă acțiunea a reușit.
status number Codul de stare HTTP returnat de Dataverse sau 0 când nu este disponibilă nicio stare HTTP. O 0 stare poate însemna că timpul de rulare a respins apelul înainte de a-l trimite (de exemplu, not_enabled, , not_bound, not_permitted, wrong_operation_kindinvalid_parametersau invalid_bound_to), solicitarea nu a reușit fără un răspuns HTTP sau rezultatul este necunoscut (indeterminate este true). Utilizați error.code și indeterminate pentru a diferenția aceste cazuri.
outputs object Parametrii de ieșire returnați de acțiune, cheiați după numele unic. Gol pentru acțiuni fără ieșiri.
indeterminate boolean (Opțional) true atunci când o expirare sau altă eroare post-expediere înseamnă că serverul poate să fi comis acțiunea; nu reîncercați automat.
error object (Opțional) Detalii despre eroare atunci când ok este false, inclusiv un dispozitiv care poate fi code citit de computer și un sanitizat message. codeeste unul dintre not_enabled, , not_permittedinvalid_parameternot_boundwrong_operation_kindinvalid_bound_to, indeterminate, sau networkcodul de stare HTTP al acțiunii ca un șir (de exemplu, "404") atunci când Dataverse a returnat un răspuns de eroare sau "0" când nu a fost disponibilă nicio stare HTTP. not_permitted înseamnă că acțiunea sau funcția nu se află pe lista de permisiuni a mediului pentru pagini generatorii - nu indică dacă utilizatorul curent deține privilegiile Dataverse pentru a-l rula. O eroare de privilegiu se afișează de obicei ca status: 403 în cazul codului "403"de eroare; dacă gazda nu poate determina starea HTTP, ea se întoarce status: 0 în schimb.

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

Apelează un API particularizat Dataverse legat la pagină ca funcție (un mesaj doar în citire cu GET semantics).

Parametri

Setați o valoare pentru acest parametru obligatoriu.

Nume Tip Descriere
request DataverseFunctionRequest Funcția de invocat și parametrii săi de intrare.

DataverseFunctionRequest

Nume Tip Descriere
name string Numele unic al API-ului particularizat, prefixat de editor, cum new_GetExchangeRatear fi .
parameters object (Opțional) Parametrii de intrare solicitați de funcție, tastă după numele unic al parametrului.
boundTo object (Opțional) O referință de rând țintă (entityName și id) pentru funcțiile legate de entitate. Omiteți funcțiile globale (nelegate).

Retururi

O promisiune care conține o DataverseActionResult. Ca și în executeActioncazul , această metodă nu generează niciodată erori așteptate - verificați ok proprietatea în schimb.

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

Listează API-urile particularizate (acțiuni și funcții) particularizate pe care un creator le-a legat la pagină.

Parametri

None.

Retururi

O promisiune care conține o matrice de intrări DataverseActionInfo . Returnează o matrice goală atunci când descoperirea nu este activată pentru modulul runtime.

DataverseActionInfo

DataverseActionInfo reflectă caracteristicile legate de creatorul paginii pentru această acțiune sau funcție, nu metadate active Dataverse. Nu o utilizați pentru a construi formulare de intrare sau pentru a valida ieșirile- verificați cerințele parametrilor și formele de ieșire în raport cu definiția API particularizată reală Dataverse.

Nume Tip Descriere
name string Numele unic (logic) al API-ului particularizat Dataverse.
displayName string Numele afișat al unui API particularizat.
isFunction boolean true dacă API-ul particularizat Dataverse este o funcție (doar în citire); false dacă este o acțiune, inclusiv atunci când această valoare nu a fost înregistrată la momentul legării.
bindingType string Tipul de legare: "Global" sau "Entity".
boundEntityLogicalName string (Opțional) Tabelul la care este legată acțiunea sau funcția, când bindingType este "Entity".
parameters Object[] Parametrii de intrare înregistrați atunci când API-ul particularizat Dataverse era legat la pagină, fiecare cu un name și declaredKind. type este întotdeauna "unknown" și optional este întotdeauna false - nici nu reflectă metadatele API particularizate Dataverse.
outputs Object[] Întotdeauna o matrice goală. Descoperirea legării nu înregistrează parametrii de ieșire.

listBoundActions Exemplu

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