getEntityMetadata (הפניה ל- API של JavaScript) עבור Dynamics 365 Channel Integration Framework 2.0

החזרת המטה-נתונים של הישות עבור הישות שצוינה.

תחביר

Microsoft.CIFramework.getEntityMetadata(entityName, attributes).then(successCallback, errorCallback)

פרמטרים

שם Type נדרש תיאור‬‏‫‬
שם ישות String כן השם הלוגי של הישות.
תכונות מערך מחרוזות לא התכונות שעבורן יש לקבל מטה-נתונים.

מחזירה

סוג: אובייקט

תיאור: אובייקט המכיל את פרטי המטה-נתונים של הישות עם התכונות הבאות.

שם תכונה Type תיאור‬‏‫‬
מסכת פעילותTypeMask מספר אם פעילות מותאמת אישית אמורה להופיע בתפריטי הפעילות ביישום האינטרנט. 0 מציין שהפעילות המותאמת אישית אינה מופיעה; 1 מציין שהוא אכן מופיע.
AutoRouteToOwnerQueue בוליאני מציין אם להעביר רשומות באופן אוטומטי לתור ברירת המחדל של הבעלים בעת יצירה או הקצאה של רשומה מסוג זה.
CanEnableSyncToExternalSearchIndex בוליאני לשימוש פנימי בלבד.
יכול טריגר זרימת עבודה בוליאני מציין אם הישות יכולה להפעיל תהליך זרימת עבודה.
תיאור‬‏‫‬ String תיאור עבור הישות.
שם התצוגה String שם תצוגה בצורת רבים עבור הישות.
שם תצוגה String שם תצוגה עבור הישות.
EnforceStateTransitions בוליאני מציין אם הישות תאכוף מעברי מצב מותאמים אישית.
EntityColor String הקוד ההקסדצימלי המייצג את הצבע שישמש עבור ישות זו ביישום.
שם EntitySetName String שם ישות ה- Web API שהוגדרה עבור ישות זו.
Hasפעילויות בוליאני מציין אם פעילויות משויכות לישות זו.
פעילות איס בוליאני מציין אם הישות היא פעילות.
IsActivityParty בוליאני מציין אם ניתן לשלוח את הודעות הדואר האלקטרוני לכתובת דואר אלקטרוני המאוחסנת ברשומה מסוג זה.
IsBusinessProcessEnabled בוליאני מציין אם הישות זמינה עבור זרימות תהליך עסקי.
IsBPFEntity בוליאני מציין אם הישות היא ישות זרימת תהליך עסקי.
ישות הילד בוליאני מציין אם הישות היא ישות צאצא.
IsConnectionsEnabled בוליאני מציין אם חיבורים זמינים עבור ישות זו.
ישות מותאמת אישית בוליאני מציין אם הישות היא ישות מותאמת אישית.
ניתן להתאמה אישית בוליאני מציין אם הישות ניתנת להתאמה אישית.
IsDocumentManagementEnabled בוליאני מציין אם ניהול מסמכים זמין.
IsDocumentRecommendationsEnabled בוליאני מציין אם המלצות המסמך זמינות.
IsDuplicateDetectionEnabled בוליאני מציין אם זיהוי כפילויות זמין.
IsEnabledForCharts בוליאני מציין אם תרשימים זמינים.
ניתן לנייד בוליאני מציין אם ניתן לייבא את הישות באמצעות אשף הייבוא.
IsInteractionCentricEnabled בוליאני מציין שהישות זמינה עבור חוויה אינטראקטיבית.
IsKnowledgeManagementEnabled בוליאני מציין אם ניהול ידע זמין עבור הישות.
IsMailMergeEnabled בוליאני מציין אם מיזוג דואר זמין עבור ישות זו.
מנוהל בוליאני מציין אם הישות היא חלק מפתרון מנוהל.
IsOneNoteIntegrationEnabled בוליאני מציין אם שילוב OneNote זמין עבור הישות.
IsOptimisticConcurrencyEnabled בוליאני מציין אם בו-זמנית אופטימית זמינה עבור הישות.
IsQuickCreateEnabled בוליאני מציין אם הישות זמינה עבור טפסי יצירה מהירה.
IsStateModelAware בוליאני מציין אם הישות תומכת בהגדרת מעברי מצב מותאמים אישית.
IsValidForAdvancedFind בוליאני מציין אם הישות מוצגת בחיפוש מתקדם.
IsVisibleInMobileClient בוליאני מציין אם משתמשי Microsoft Dynamics 365 למחשבי Tablet יכולים לראות נתונים עבור ישות זו.
IsEnabledInUnifiedInterface בוליאני מציין אם הישות זמינה עבור ממשק מאוחד.
שם האוסף הלוגי String שם האוסף הלוגי.
שם לוגי String השם הלוגי של הישות.
קוד אובייקט מספר קוד סוג הישות.
סוג בעלות String סוג הבעלות עבור הישות: "UserOwned" או "OrganizationOwned".
PrimaryIdAttribute String שם התכונה שהיא המזהה הראשי של הישות.
PrimaryImageAttribute String השם של תכונת התמונה הראשית עבור ישות.
PrimaryNameAttribute String שם התכונה הראשית עבור ישות.
הרשאות מערך אובייקטים המטה-נתונים של ההרשאות עבור הישות שבה כל אובייקט מכיל את התכונות הבאות כדי להגדיר את הרשאת האבטחה לגישה לישות:
  • CanBeBasic: בוליאני. האם ההרשאה יכולה להיות רמת גישה בסיסית.
  • CanBeDeep: בוליאני. האם ההרשאה יכולה להיות רמת גישה עמוקה.
  • CanBeEntityReference: בוליאני. אם ההרשאה עבור צד חיצוני יכולה להיות רמת גישה בסיסית.
  • CanBeGlobal: בוליאני. אם ההרשאה יכולה להיות רמת גישה גלובלית.
  • CanBeLocal: בוליאני. אם ההרשאה יכולה להיות רמת גישה מקומית.
  • CanBeParentEntityReference: בוליאני. אם ההרשאה עבור צד חיצוני יכולה להיות רמת גישת אב.
  • שם: מחרוזת. שם ההרשאה.
  • PrivilegeId: מחרוזת. מזהה ההרשאה.
  • PrivilegeType: מספר. סוג ההרשאה, שהוא אחד מהבאים:
    • 0: אין
    • 1: צור
    • 2: קרא
    • 3: כתיבה
    • 4: מחק
    • 5: הקצאה
    • 6: שתף
    • 7: צירוף
    • 8: נספח ל
תכונות אוסף אוסף של אובייקטי מטא-נתונים של תכונות. האובייקט המוחזר תלוי בסוג המטא-נתונים של התכונה.

מטה-נתונים של תכונה עבור סוג הבסיס
אובייקט המוחזר עם המאפיינים הבאים:

  • סוג תכונה: מספר. סוג של תכונה. לקבלת רשימה של ערכי סוג תכונה, ראה AttributeTypeCode
  • DisplayName: מחרוזת. שם תצוגה עבור התכונה.
  • EntityLogicalName: מחרוזת. שם לוגי של הישות המכילה את התכונה.
  • LogicalName: מחרוזת. שם לוגי עבור התכונה.

מטה-נתונים של תכונה עבור הסוג הבוליאני
אובייקט המוחזר עם המאפיינים הבאים בנוסף למאפייני סוג המטה-נתונים של תכונת הבסיס :

  • DefaultFormValue: בוליאני. ערך ברירת מחדל עבור קבוצת אפשרויות בוליאנית.
  • OptionSet: אובייקט. אפשרויות לתכונה בוליאנית שבה כל אפשרות היא צמד מפתח:ערך.

מטה-נתונים של תכונה עבור סוג הספירה
אובייקט המוחזר עם המאפיינים הבאים בנוסף למאפייני סוג המטה-נתונים של תכונת הבסיס :

  • OptionSet: אובייקט. אפשרויות לתכונה שבה כל אפשרות היא צמד מפתח:ערך.

מטה-נתונים של תכונה עבור סוג רשימת הבחירה
אובייקט המוחזר עם המאפיינים הבאים בנוסף למאפייני סוג המטה-נתונים של תכונת הבסיס :

  • DefaultFormValue: מספר. ערך טופס ברירת מחדל עבור התכונה.
  • OptionSet: אובייקט. אפשרויות לתכונה שבה כל אפשרות היא צמד מפתח:ערך.

מטה-נתונים של תכונה עבור סוג המצב
אובייקט המוחזר עם המאפיינים הבאים בנוסף למאפייני סוג המטה-נתונים של תכונת הבסיס :

  • OptionSet: אובייקט. אפשרויות לתכונה שבה כל אפשרות היא צמד מפתח:ערך.

האובייקט כולל גם את השיטות הבאות:

  • getDefaultStatus(arg): החזרת מצב ברירת המחדל (מספר) בהתבסס על ערך המצב שהועבר עבור ישות. לקבלת ערכי מצב ומצב המוגדרים כברירת מחדל עבור ישות, ראה מידע מטה-נתונים של ישות של הישות בהפניה לישות.
  • getStatusValuesForState(arg): החזרת ערכי מצב אפשריים (מערך מספרים) עבור ערך מצב שצוין. לערכי מצב ומצב עבור ישות, ראה מידע מטה-נתונים של ישות של הישות בהפניה לישות.

מטה-נתונים של תכונה עבור סוג המצב
אובייקט המוחזר עם המאפיינים הבאים בנוסף למאפייני סוג המטה-נתונים של תכונת הבסיס :

  • OptionSet: אובייקט. אפשרויות לתכונה שבה כל אפשרות היא צמד מפתח:ערך.

האובייקט מכיל גם את פעולת השירות הבאה:

  • getState(arg): החזרת ערך המצב (number) עבור ערך המצב (number) שצוין. לקבלת ערכי מצב ומצב המוגדרים כברירת מחדל עבור ישות, ראה מידע מטה-נתונים של ישות של הישות בהפניה לישות.

דוגמאות

// Get the metadata of "account" entity    
Microsoft.CIFramework.getEntityMetadata("account").then(
    function (result) {
        // result will have metadata of account, no attribute information will be fetched as the optional list is not passed.
        console.log(result)
    },
    function (error) {
        // code handling for promise failure
        console.log(error)
    });

// Get the metadata of "account" entity with empty attributes list.  
Microsoft.CIFramework.getEntityMetadata("account", []).then(
    function (result) {
        // result will have metadata of account, no attribute information will be fetched as the attributes list passed is empty.
        console.log(result)
    },
    function (error) {
        // code handling for promise failure
        console.log(error)
    });


// Get the metadata of "account" entity with specific attributes "createdon" and "name" info.  
Microsoft.CIFramework.getEntityMetadata("account", ['createdon', 'name']).then(
    function (result) {
        // result will have metadata of account, as well as attribute information for "createdon" and "name".
        console.log(result)
    },
    function (error) {
        // code handling for promise failure
        console.log(error)
    });
  • ‏‏עודכן לאחרונה בתאריך