Megjegyzés
Az oldalhoz való hozzáféréshez engedély szükséges. Megpróbálhat bejelentkezni vagy módosítani a címtárat.
Az oldalhoz való hozzáféréshez engedély szükséges. Megpróbálhatja módosítani a címtárat.
Az objektum művelet- és függvénymetódusaival meghívhatja a dataApi laphoz kötött Dataverse egyéni API-kat .
Megjegyzés
A művelet- és függvénymetelyek nem kötelezőek a megosztott dataApi szerződésben. Egyes gazdagépek nem implementálják őket, ezért a meghívás előtt ellenőrizze, hogy létezik-e metódus. A jelen lévő metódusok nem jelentik azt, hogy a művelet a laphoz van kötve, engedélyezve van a futtatókörnyezetben, vagy engedélyezett az aktuális felhasználó számára. Az összekötő módszerekkel ellentétben ezek a módszerek soha nem dobnak a várt hibákra; ehelyett egy hibakóddal ok: false oldják meg őket. Az eredmény ok és error a tulajdonságok explicit kezelése.
listBoundActions visszaadja azokat a műveleteket és függvényeket, amelyeket az aktuális futtatókörnyezet-konfiguráció engedélyez a lap számára, ha a felderítés engedélyezve van; ez nem garantálja, hogy az aktuális felhasználó rendelkezik az összes felsorolt művelet végrehajtásához szükséges Dataverse-jogosultságokkal.
| Method | Description |
|---|---|
executeAction |
Műveletként meghívja a laphoz kötött Egyéni Dataverse API-t. |
executeFunction |
Függvényként meghívja a laphoz kötött egyéni Dataverse API-t. |
listBoundActions |
A laphoz kötött Dataverse egyéni API-k (műveletek és függvények) listája. |
executeAction módszer
Egyéni Dataverse API-t hív meg, amelyet egy készítő műveletként kötött a laphoz (amely adatokat módosíthat).
Parameters
Adjon meg egy értéket ehhez a kötelező paraméterhez.
| Name | Típus | Description |
|---|---|---|
request |
DataverseActionRequest | A meghívandó művelet és a bemeneti paraméterek. |
DataverseActionRequest
| Name | Típus | Description |
|---|---|---|
name |
string |
Az egyéni API egyedi neve, közzétevői előtaggal, például new_ApproveExpenseReport. |
parameters |
object |
(Nem kötelező) A művelet által megkövetelt bemeneti paraméterek, amelyeket a paraméter egyedi neve alapján kell megadni. |
boundTo |
object |
(Nem kötelező) Az entitáshoz kötött műveletek célsor-hivatkozása (entityName és id) Kihagyja a globális (kötetlen) műveleteket. |
Returns
Egy DataverseActionResult-et tartalmazó ígéret. Ez a módszer soha nem ad vissza várt hibákat (például 403-as engedélyhiba, 400 hibás paraméter, vagy a műveletet nem köti le vagy nem engedélyezi) – ellenőrizze inkább a ok tulajdonságot.
DataverseActionResult
| Name | Típus | Description |
|---|---|---|
ok |
boolean |
Azt jelzi, hogy a művelet sikeres volt-e. |
status |
number |
A Dataverse által visszaadott HTTP-állapotkód, vagy 0 ha nem érhető el HTTP-állapot. Az 0 állapot azt jelentheti, not_enabledhogy a futtatókörnyezet elutasította a hívást a küldés előtt (például, , not_bound, not_permitted, wrong_operation_kind, invalid_parametervagy invalid_bound_to), a kérés HTTP-válasz nélkül meghiúsult, vagy az eredmény ismeretlen (indeterminate is true). Használja error.code és indeterminate mondja el ezeket az eseteket külön. |
outputs |
object |
A művelet által visszaadott kimeneti paraméterek egyedi névvel kulcsoltak. Kimenet nélküli műveletek esetén üres. |
indeterminate |
boolean |
(Nem kötelező) true időtúllépés vagy más post-dispatch hiba esetén előfordulhat, hogy a kiszolgáló véglegesítette a műveletet; ne próbálkozzon automatikusan. |
error |
object |
(Nem kötelező) Hiba részletei, ha ok van false, beleértve egy géppel code olvasható és egy fertőtlenített message.
codeaz egyik , , , , wrong_operation_kindinvalid_parameter, invalid_bound_to, indeterminatevagy network, vagy a művelet HTTP-állapotkódja sztringként (például) akkor, "404"amikor a Dataverse hibaválaszt adott vissza, vagy "0" ha nem volt elérhető HTTP-állapot. not_permittednot_boundnot_enabled
not_permitted azt jelenti, hogy a művelet vagy függvény nem szerepel a környezet generatív lapok engedélyezési listájában – nem jelzi, hogy az aktuális felhasználó rendelkezik-e a Dataverse-jogosultságokkal a futtatáshoz. A jogosultsági hibák általában hibakódként "403"jelennek megstatus: 403; ha a gazdagép nem tudja meghatározni a HTTP-állapotot, akkor az eredményül ad status: 0 vissza. |
executeAction példa
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 módszer
Meghív egy egyéni Dataverse API-t, amelyet egy készítő függvényként kötött a laphoz (csak olvasható üzenet GET szemantikával).
Parameters
Adjon meg egy értéket ehhez a kötelező paraméterhez.
| Name | Típus | Description |
|---|---|---|
request |
DataverseFunctionRequest | A meghívandó függvény és a bemeneti paraméterek. |
DataverseFunctionRequest
| Name | Típus | Description |
|---|---|---|
name |
string |
Az egyéni API egyedi neve, közzétevői előtaggal, például new_GetExchangeRate. |
parameters |
object |
(Nem kötelező) A függvény által megkövetelt bemeneti paraméterek, amelyeket a paraméter egyedi neve alapján kell megadni. |
boundTo |
object |
(Nem kötelező) Az entitáshoz kötött függvények célsor-hivatkozása (entityName és id) Kihagyja a globális (kötetlen) függvényeket. |
Returns
Egy DataverseActionResult-et tartalmazó ígéret. A módszerhez executeActionhasonlóan ez a módszer sem a várt hibákra ad vissza – ellenőrizze inkább a tulajdonságot ok .
executeFunction példa
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 módszer
Azokat a Dataverse egyéni API-kat (műveleteket és függvényeket) sorolja fel, amelyeket a készítők a laphoz kötnek.
Parameters
None.
Returns
A DataverseActionInfo bejegyzéseket tartalmazó ígéret. Üres tömböt ad vissza, ha a felderítés nincs engedélyezve a futtatókörnyezetben.
DataverseActionInfo
DataverseActionInfo A művelethez vagy függvényhez kötött lap készítője nem az élő Dataverse-metaadatokat jeleníti meg. Ne használja bemeneti űrlapok létrehozására vagy kimenetek ellenőrzésére – ellenőrizze a paraméterkövetelményeket és a kimeneti alakzatokat a dataverse egyéni API-definícióval szemben.
| Name | Típus | Description |
|---|---|---|
name |
string |
A Dataverse egyéni API egyedi (logikai) neve. |
displayName |
string |
Egy egyéni API megjelenítendő neve. |
isFunction |
boolean |
true ha a Dataverse egyéni API függvény (írásvédett); false ha ez egy művelet, beleértve azt is, ha ezt az értéket nem rögzítették kötéskor. |
bindingType |
string |
A kötés típusa: "Global" vagy "Entity". |
boundEntityLogicalName |
string |
(Nem kötelező) Az a tábla, amelyhez a művelet vagy függvény hozzá van kötve, mikor bindingType van "Entity". |
parameters |
Object[] |
Azok a bemeneti paraméterek, amikor a Dataverse egyéni API-t a laphoz kötötték, mindegyikhez egy name és declaredKind.
type
"unknown" mindig és optional mindig false is – egyik sem tükrözi a Dataverse egyéni API tényleges metaadatait. |
outputs |
Object[] |
Mindig üres tömb. A kötésfelderítés nem rögzíti a kimeneti paramétereket. |
listBoundActions Példa
const actions = await dataApi.listBoundActions?.();