שתף דרך


getEntityMetadata (Client API)

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

תחביר

Xrm.Utility.getEntityMetadata(entityName,attributes).then(successCallback, errorCallback)

Parameters

שם Type נדרש תיאור
entityName String כן השם הלוגי של הטבלה.
attributes מערך של מחרוזות לא העמודות שעבורן יש לקבל הגדרות.
successCallback פונקציה לא פונקציה להתקשרות כאשר הגדרות הטבלה מוחזרות.
errorCallback פונקציה לא פונקציה שיש לקרוא לה כאשר הפעולה נכשלת.

Returns

סוג: אובייקט

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

שם Type תיאור
ActivityTypeMask מספר אם פעילות מותאמת אישית אמורה להופיע בתפריטי הפעילות ביישום האינטרנט. 0 מציין שהפעילות המותאמת אישית אינה מופיעה; 1 מציין שהיא מופיעה.
AutoRouteToOwnerQueue בוליאני ציון אם להעביר באופן אוטומטי רשומות לתור ברירת המחדל של הבעלים בעת יצירה או הקצאה של רשומה מסוג זה.
CanEnableSyncToExternalSearchIndex בוליאני לשימוש פנימי בלבד.
CanTriggerWorkflow בוליאני מציין אם הטבלה יכולה להפעיל תהליך זרימת עבודה.
Description String תיאור הטבלה.
DisplayCollectionName String שם תצוגה רבים עבור הטבלה.
DisplayName String שם תצוגה עבור הטבלה.
EnforceStateTransitions בוליאני מציין אם הטבלה אוכפת מעברי מצב מותאמים אישית.
EntityColor String הקוד ההקסדצימאלי המייצג את הצבע שישמש עבור טבלה זו ביישום.
EntitySetName String שם טבלת ה- API של האינטרנט המוגדרת עבור טבלה זו.
HasActivities בוליאני מציין אם פעילויות משויכת לטבלה זו.
IsActivity בוליאני מציין אם הטבלה היא פעילות.
IsActivityParty בוליאני מציין אם ניתן לשלוח את הודעות הדואר האלקטרוני לכתובת דואר אלקטרוני המאוחסנת ברשומה מסוג זה.
IsBusinessProcessEnabled בוליאני מציין אם הטבלה זמינה עבור זרימות תהליכים עסקיים.
IsBPFEntity בוליאני מציין אם הטבלה היא טבלת זרימת תהליך עסקי.
IsChildEntity בוליאני מציין אם הטבלה היא טבלת צאצא.
IsConnectionsEnabled בוליאני מציין אם חיבורים זמינים עבור טבלה זו.
IsCustomEntity בוליאני מציין אם הטבלה היא טבלה מותאמת אישית.
IsCustomizable בוליאני מציין אם הטבלה ניתנת להתאמה אישית.
IsDocumentManagementEnabled בוליאני מציין אם ניהול מסמכים זמין.
IsDocumentRecommendationsEnabled בוליאני מציין אם המלצות המסמך זמינות.
IsDuplicateDetectionEnabled בוליאני מציין אם זיהוי כפילויות זמין.
IsEnabledForCharts בוליאני מציין אם תרשימים זמינים.
IsImportable בוליאני ציון אם ניתן לייבא את הטבלה באמצעות אשף הייבוא.
IsInteractionCentricEnabled בוליאני מציין שהטבלה זמינה עבור חוויה אינטראקטיבית.
IsKnowledgeManagementEnabled בוליאני ציון אם ניהול ידע זמין עבור הטבלה.
IsMailMergeEnabled בוליאני מציין אם מיזוג דואר זמין עבור טבלה זו.
IsManaged בוליאני מציין אם הטבלה מהווה חלק מפתרון מנוהל.
IsOneNoteIntegrationEnabled בוליאני מציין אם שילוב OneNote זמין עבור הטבלה.
IsOptimisticConcurrencyEnabled בוליאני ציון אם התרחשות בו-זמנית אופטימית זמינה עבור הטבלה.
IsQuickCreateEnabled בוליאני מציין אם הטבלה זמינה עבור טפסי יצירה מהירה.
IsStateModelAware בוליאני ציון אם הטבלה תומכת בהגדרת מעברי מצב מותאמים אישית.
IsValidForAdvancedFind בוליאני ציון אם הטבלה תוצג ב'חיפוש מתקדם'.
IsVisibleInMobileClient בוליאני מציין אם משתמשי Microsoft Dynamics 365 עבור מחשבי Tablet יכולים לראות נתונים עבור טבלה זו.
IsEnabledInUnifiedInterface בוליאני מציין אם הטבלה זמינה עבור ממשק מאוחד.
LogicalCollectionName String שם האוסף הלוגי.
LogicalName String השם הלוגי עבור הטבלה.
ObjectTypeCode מספר קוד סוג הטבלה.
OwnershipType String סוג הבעלות עבור הטבלה: UserOwned או OrganizationOwned.
PrimaryIdAttribute String שם העמודה שמהו המזהה הראשי עבור הטבלה.
PrimaryImageAttribute String השם של עמודת התמונה הראשית עבור טבלה.
PrimaryNameAttribute String שם העמודה הראשית עבור טבלה.
Privileges מערך אובייקטים אובייקטים המגדירים את הרשאת האבטחה לגישה לטבלה. ראה אובייקט הרשאה
Attributes Collection אוסף של אובייקטים של הגדרות עמודות. ראה אובייקטי תכונה

אובייקט הרשאה

לאובייקטי הרשאה יש את המאפיינים הבאים להגדרת הרשאת האבטחה לגישה לטבלה:

שם Type תיאור
CanBeBasic בוליאני האם ההרשאה יכולה להיות רמת גישה בסיסית.
CanBeDeep בוליאני האם ההרשאה יכולה להיות רמת גישה עמוקה.
CanBeEntityReference בוליאני אם ההרשאה עבור צד חיצוני יכולה להיות רמת גישה בסיסית.
CanBeGlobal בוליאני אם ההרשאה יכולה להיות רמת גישה גלובלית.
CanBeLocal בוליאני אם ההרשאה יכולה להיות רמת גישה מקומית.
CanBeParentEntityReference בוליאני אם ההרשאה עבור צד חיצוני יכולה להיות רמת גישת אב.
Name String שם ההרשאה.
PrivilegeId String מזהה ההרשאה.
PrivilegeType מספר סוג ההרשאה, שהוא אחד מהבאים:
0 : ללא
1: צור
2: קריאה
3 : כתיבה
4 : מחק
5 : הקצאה
6 : שיתוף
7 : צירוף
8 : AppendTo

אובייקטי תכונה

האובייקט המוחזר תלוי בסוג הגדרות העמודות.

עמודות בסיס (AttributeMetadata)

כל הגדרות העמודות כוללות מאפיינים משותפים אלה:

שם Type תיאור
AttributeType מספר סוג עמודה. לקבלת רשימה של ערכי סוג עמודה, ראה Enum של AttributeTypeCode
DisplayName String שם תצוגה עבור העמודה
EntityLogicalName String שם לוגי של הטבלה המכילה את העמודה.
LogicalName String שם לוגי עבור העמודה.

עמודות 'כן/לא' (BooleanAttributeMetadata)

עמודות כן/לא כוללות מאפיינים אלה:

שם Type תיאור
DefaultFormValue בוליאני ערך ברירת מחדל עבור עמודת כן/לא.
OptionSet Object אפשרויות עבור העמודה הבוליאנית שבה כל אפשרות היא זוג key:value.

עמודות בחירה (PicklistAttributeMetadata)

עמודות בחירה כוללות מאפיין זה:

שם Type תיאור
OptionSet Object אפשרויות עבור העמודה שבה כל אפשרות היא זוג key:value.

עמודות של אפשרויות (MultiSelectPicklistAttributeMetadata)

עמודות אפשרויות כוללות מאפיינים אלה:

שם Type תיאור
DefaultFormValue בוליאני ערך ברירת מחדל עבור העמודה.
OptionSet Object אפשרויות עבור העמודה הבוליאנית שבה כל אפשרות היא זוג key:value.

עמודות מצב (StateAttributeMetadata)

עמודות מצב כוללות מאפיין זה:

שם Type תיאור
OptionSet Object אפשרויות עבור העמודה שבה כל אפשרות היא זוג key:value.

עמודות מצב כוללות גם פעולות שירות אלה המקבלות את הערך של אחד OptionSet מערכים אלה של האפשרויות בתור הפרמטר arg .

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

עמודות מצב (StatusAttributeMetadata)

עמודות מצב כוללות מאפיין זה:

שם Type תיאור
OptionSet Object אפשרויות עבור העמודה שבה כל אפשרות היא זוג key:value.

עמודות מצב כוללות גם שיטה זו המקבלת את הערך של אחד OptionSet מערכים של האפשרויות בתור הפרמטר arg .

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

Xrm.Utility