הערה
הגישה לדף זה מחייבת הרשאה. באפשרותך לנסות להיכנס או לשנות מדריכי כתובות.
הגישה לדף זה מחייבת הרשאה. באפשרותך לנסות לשנות מדריכי כתובות.
השתמש בשיטות הפעולה והפונקציה של dataApi האובייקט כדי להפעיל ממשקי API מותאמים אישית של Dataverse המאוגדים לדף.
הערה
פעולות שירות של פעולה ופונקציה הן אופציונליות בחוזה המשותף dataApi . מארחים מסוימים אינם מיישמים אותם, לכן ודא ששיטה קיימת לפני השיחות אליה. פעולת שירות קיימת אינה מתכוונת שהפעולה מאוגדת לדף, זמינה עבור זמן הריצה או המותרת עבור המשתמש הנוכחי. בשונה משיטות מחבר, שיטות אלה לעולם לא ישלינו לכשלים הצפויים; הם פותרים עם ok: false וקוד שגיאה במקום זאת. טפל במאפיינים ובמאפיינים okerror של התוצאה באופן מפורש.
listBoundActions מחזירה את הפעולות והפונקציות שתצורות זמן הריצה הנוכחיות מאפשרות עבור הדף כאשר גילוי זה זמין; אין ערובה לכך שהמשתמש הנוכחי מחזיק בהרשאות Dataverse הדרושות לביצוע כל פעולה רשומה.
| שיטה | תיאור |
|---|---|
executeAction |
הפעלת API מותאם אישית של Dataverse המאוגד לדף כפעולה. |
executeFunction |
הפעלת API מותאם אישית של Dataverse המאוגד לדף כפונקציה. |
listBoundActions |
פירוט ממשקי ה- API המותאמים אישית של Dataverse (פעולות ופונקציות) המאוגדים לדף. |
executeAction שיטת
הפעלת API מותאם אישית מסוג Dataverse היוצר מאוגד לדף כפעולה (הודעה שעשויה לשנות נתונים).
פרמטרים
הגדר ערך עבור פרמטר נדרש זה.
| שם | סוג | תיאור |
|---|---|---|
request |
DataverseActionRequest | הפעולה להפעלה ולפרמטרים של הקלט שלה. |
DataverseActionRequest
| שם | סוג | תיאור |
|---|---|---|
name |
string |
השם הייחודי של ה- API המותאם אישית, עם קידומת המוציא לאור, כגון new_ApproveExpenseReport. |
parameters |
object |
(אופציונלי) פרמטרי הקלט הנדרשים על-ידי הפעולה, הממפתחים לפי שם ייחודי של פרמטר. |
boundTo |
object |
(אופציונלי) הפניה לשורת יעד (entityName ו id- ) עבור פעולות המאוגדות לישות. השמט עבור פעולות כלליות (לא מאוגדות). |
החזרות
הבטחה המכילה DataverseActionResult. שיטה זו לעולם אינה מתרחשת עבור הכשלים הצפויים (כגון שגיאת הרשאה מסוג 403, פרמטר שגוי של 400 או שהפעולה אינה מאוגדת או מופעלת) - ok בדוק את המאפיין במקום זאת.
DataverseActionResult
| שם | סוג | תיאור |
|---|---|---|
ok |
boolean |
מציין אם הפעולה הצליחה. |
status |
number |
קוד המצב של HTTP שהוחזר על-ידי 0 Dataverse, או כאשר אין מצב HTTP זמין. מצב 0 יכול להוסיף לכך ש זמן הריצה דחה את השיחה לפני שליחתה (לדוגמה, not_enabled, not_bound, not_permitted, wrong_operation_kind, invalid_parameterinvalid_bound_toאו ), הבקשה נכשלה ללא תגובת HTTP, או שהתוצאה אינה ידועה (indeterminate היא true). השתמש error.code במקרים אלה indeterminate וב כדי להפריד ביניהם. |
outputs |
object |
הפרמטרים של הפלט המוחזרים על-ידי הפעולה, המקש לפי שם ייחודי. ריק עבור פעולות ללא פלט. |
indeterminate |
boolean |
(אופציונלי) true כאשר תם הזמן הקצוב או כשל אחר לאחר שיגור, ייתכן שהשרת ביצע את הפעולה; אל תבחן שוב באופן אוטומטי. |
error |
object |
(אופציונלי) פרטי שגיאה כאשר ok הוא false, כולל קריאה של מחשב code ו- .message
codeהוא אחד not_enabledמ- , not_bound, wrong_operation_kindnot_permitted, invalid_parameter, invalid_bound_to, indeterminate, networkאו , או קוד מצב HTTP של הפעולה כמחרוזת (לדוגמה, "404") כאשר Dataverse החזיר תגובת שגיאה, "0" או כאשר לא היה מצב HTTP זמין.
not_permitted כלומר, הפעולה או הפונקציה אינן מופיעות ברשימת היתרים של הסביבה עבור דפים generative – היא אינה מציינת אם המשתמש הנוכחי מחזיק בהרשאות Dataverse כדי להפעיל אותו. כשל הרשאה מוצג בדרך כלל בדומה status: 403 לקוד שגיאה "403"; אם המארח אינו יכול לקבוע את מצב ה- HTTP, הוא חוזר במקום status: 0 זאת. |
דוגמה ל- executeAction
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 שיטת
הפעלת API מותאם אישית מסוג Dataverse היוצר מאוגד לדף כפונקציה (הודעה לקריאה בלבד עם סמנטיקה של GET).
פרמטרים
הגדר ערך עבור פרמטר נדרש זה.
| שם | סוג | תיאור |
|---|---|---|
request |
DataverseFunctionRequest | הפונקציה להפעלה ולפרמטרים של הקלט שלה. |
DataverseFunctionRequest
| שם | סוג | תיאור |
|---|---|---|
name |
string |
השם הייחודי של ה- API המותאם אישית, עם קידומת המוציא לאור, כגון new_GetExchangeRate. |
parameters |
object |
(אופציונלי) פרמטרי הקלט הנדרשים על-ידי הפונקציה, המקש לפי שם ייחודי של פרמטר. |
boundTo |
object |
(אופציונלי) הפניה לשורת יעד (entityName ו id- ) עבור פונקציות המאוגדות בישות. השמט עבור פונקציות כלליות (לא מאוגדות). |
החזרות
הבטחה המכילה DataverseActionResult. בדומה ל- executeAction, שיטה זו לעולם אינה מתרחשת עבור הכשלים הצפויים - בדוק את המאפיין ok במקום זאת.
דוגמה ל- 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 שיטת
פירוט ממשקי ה- API המותאמים אישית (פעולות ופונקציות) של Dataverse היוצרים מאוגדים לדף.
פרמטרים
None.
החזרות
הבטחה המכילה מערך של ערכי DataverseActionInfo. החזרת מערך ריק כאשר גילוי אינו זמין עבור זמן הריצה.
DataverseActionInfo
DataverseActionInfo משקף את הגבול של יוצר הדף עבור פעולה או פונקציה זו, ולא מטה-נתונים חיים של Dataverse. אל תשתמש בה כדי לבנות טפסי קלט או לאמת פלטים - אמת את דרישות הפרמטרים ואת צורות הפלט מול הגדרת ה- API המותאמת אישית בפועל של Dataverse.
| שם | סוג | תיאור |
|---|---|---|
name |
string |
השם הייחודי (לוגי) של ה- API המותאם אישית Dataverse. |
displayName |
string |
שם התצוגה של API מותאם אישית. |
isFunction |
boolean |
true אם ה- API המותאם אישית Dataverse הוא פונקציה (לקריאה בלבד); false אם זוהי פעולה, כולל הזמן שבו ערך זה לא נרשם במועד האיגוד. |
bindingType |
string |
סוג האיגוד: "Global" או "Entity". |
boundEntityLogicalName |
string |
(אופציונלי) הטבלה שהפעולה או הפונקציה מאוגדות לה, כאשר היא bindingType ."Entity" |
parameters |
Object[] |
פרמטרי הקלט נרשמו כאשר ה- API המותאם אישית Dataverse אוגד לדף, כל אחד עם ו name - declaredKind.
type הוא תמיד ותמיד "unknown" - optional אף אחד מהם אינו false משקף את המטה-נתונים הממשיים של ה- API המותאם אישית Dataverse. |
outputs |
Object[] |
תמיד מערך ריק. גילוי איגוד אינו מקליט פרמטרים של פלט. |
listBoundActions דוגמה
const actions = await dataApi.listBoundActions?.();