getEntityMetadata (αναφορά API JavaScript) για το Dynamics 365 Channel Integration Framework 2.0

Επιστρέφει τα μετα-δεδομένα οντότητας για την καθορισμένη οντότητα.

Syntax

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

Parameters

Ονομασία	Type	Απαραίτητο	Περιγραφή
entityName	String	Όχι	Το λογικό όνομα της οντότητας.
Χαρακτηριστικά	Πίνακας συμβολοσειρών	όχι	Τα χαρακτηριστικά για τα οποία θα λάβετε μεταδεδομένα.

Returns

Τύπος: Αντικείμενο

Περιγραφή: Ένα αντικείμενο που περιέχει τις πληροφορίες μετα-δεδομένων οντότητας με τα ακόλουθα χαρακτηριστικά.

Όνομα χαρακτηριστικού	Type	Περιγραφή
ActivityTypeMask	Αριθμός	Εάν μια προσαρμοσμένη δραστηριότητα πρέπει να εμφανίζεται στα μενού δραστηριότητας της εφαρμογής Web. Το 0 υποδεικνύει ότι η προσαρμοσμένη δραστηριότητα δεν εμφανίζεται. Το 1 υποδεικνύει ότι εμφανίζεται.
AutoRouteToOwnerQueue	Δυαδική	Υποδεικνύει εάν θα μετακινούνται αυτόματα εγγραφές στην προεπιλεγμένη ουρά του κατόχου όταν δημιουργείται ή εκχωρείται μια εγγραφή αυτού του τύπου.
CanEnableSyncToExternalSearchIndex	Δυαδική	Μόνο για εσωτερική χρήση.
CanTriggerΡοή εργασίας	Δυαδική	Υποδεικνύει εάν η οντότητα μπορεί να ενεργοποιήσει μια διαδικασία ροής εργασίας.
Περιγραφή	String	Περιγραφή της οντότητας.
DisplayCollectionName	String	Πληθυντικό εμφανιζόμενο όνομα για την οντότητα.
Εμφανιζόμενο όνομα	String	Εμφανιζόμενο όνομα για την οντότητα.
EnforceStateTransitions	Δυαδική	Υποδεικνύει εάν η οντότητα θα επιβάλει προσαρμοσμένες μεταβάσεις κατάστασης.
EntityColor	String	Ο δεκαεξαδικός κωδικός που αντιπροσωπεύει το χρώμα που θα χρησιμοποιηθεί για αυτήν την οντότητα στην εφαρμογή.
EntitySetName	String	Το όνομα της οντότητας Web API που έχει οριστεί για αυτήν την οντότητα.
ΈχειΔραστηριότητες	Δυαδική	Υποδεικνύει εάν οι δραστηριότητες σχετίζονται με αυτήν την οντότητα.
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	Δυαδική	Υποδεικνύει εάν η οντότητα είναι ενεργοποιημένη για ενοποιημένο περιβάλλον εργασίας.
ΛογικόΌνομαΣυλλογής	String	Το όνομα της λογικής συλλογής.
ΛογικόΌνομα	String	Το λογικό όνομα για την οντότητα.
ObjectTypeCode	Αριθμός	Ο κωδικός τύπου οντότητας.
ΙδιοκτησίαΤύπος	String	Ο τύπος ιδιοκτησίας για την οντότητα: "UserOwned" ή "OrganizationOwned".
PrimaryIdAttribute	String	Το όνομα του χαρακτηριστικού που είναι το κύριο αναγνωριστικό για την οντότητα.
PrimaryImageAttribute	String	Το όνομα του χαρακτηριστικού κύριας εικόνας για μια οντότητα.
PrimaryNameAttribute	String	Το όνομα του πρωτεύοντος χαρακτηριστικού για μια οντότητα.
Προνόμια	Πίνακας αντικειμένων	Τα μετα-δεδομένα δικαιωμάτων για την οντότητα όπου κάθε αντικείμενο περιέχει τα ακόλουθα χαρακτηριστικά για τον καθορισμό του προνομίου ασφαλείας για πρόσβαση σε μια οντότητα: CanBeBasic: Boolean. Εάν το δικαίωμα μπορεί να είναι βασικό επίπεδο πρόσβασης. CanBeDeep: Boolean. Εάν το προνόμιο μπορεί να είναι επίπεδο βαθιάς πρόσβασης. CanBeEntityReference: Boolean. Εάν το προνόμιο για ένα εξωτερικό μέρος μπορεί να είναι βασικό επίπεδο πρόσβασης. CanBeGlobal: Boolean. Εάν το προνόμιο μπορεί να είναι καθολικό επίπεδο πρόσβασης. CanBeLocal: Boolean. Εάν το δικαίωμα μπορεί να είναι επίπεδο τοπικής πρόσβασης. CanBeParentEntityReference: Boolean. Εάν το προνόμιο για ένα εξωτερικό μέρος μπορεί να είναι γονικό επίπεδο πρόσβασης. Όνομα: Συμβολοσειρά. Το όνομα του προνομίου. PrivilegeId: Συμβολοσειρά. Το αναγνωριστικό του προνομίου. PrivilegeType: Αριθμός. Ο τύπος προνομίου, ο οποίος είναι ένας από τους εξής: 0: Κανένα 1: Δημιουργία 2: Διαβάστε 3: Γράψτε 4: Διαγραφή 5: Εκχώρηση 6: Μοιραστείτε 7: Προσάρτηση 8: Προσάρτημα
Χαρακτηριστικά	Συλλογή	Μια συλλογή αντικειμένων μεταδεδομένων χαρακτηριστικών. Το αντικείμενο που επιστρέφεται εξαρτάται από τον τύπο των μετα-δεδομένων χαρακτηριστικού. Μετα-δεδομένα χαρακτηριστικού για τον βασικό τύπο Ένα αντικείμενο που επιστρέφεται με τις ακόλουθες ιδιότητες: AttributeType: Αριθμός. Τύπος χαρακτηριστικού. Για μια λίστα τιμών τύπου χαρακτηριστικού, ανατρέξτε στο θέμα AttributeTypeCode Εμφανιζόμενο όνομα: συμβολοσειρά. Εμφανιζόμενο όνομα για το χαρακτηριστικό. EntityLogicalName: Συμβολοσειρά. Λογικό όνομα της οντότητας που περιέχει το χαρακτηριστικό. LogicalName: Συμβολοσειρά. Λογικό όνομα για το χαρακτηριστικό. Μετα-δεδομένα χαρακτηριστικού για τον δυαδικό τύπο Ένα αντικείμενο επιστρέφεται με τις ακόλουθες ιδιότητες εκτός από τις ιδιότητες τύπου μετα-δεδομένων βασικού χαρακτηριστικού: DefaultFormValue: Boolean. Προεπιλεγμένη τιμή για ένα σύνολο επιλογών Boolean. OptionSet: Αντικείμενο. Επιλογές για το χαρακτηριστικό boolean όπου κάθε επιλογή είναι ένα ζεύγος κλειδιού:τιμής. Μεταδεδομένα χαρακτηριστικού για τον τύπο enum Ένα αντικείμενο επιστρέφεται με τις ακόλουθες ιδιότητες εκτός από τις ιδιότητες τύπου μετα-δεδομένων βασικού χαρακτηριστικού: OptionSet: Αντικείμενο. Επιλογές για το χαρακτηριστικό όπου κάθε επιλογή είναι ένα ζεύγος κλειδιού:τιμής. Μετα-δεδομένα χαρακτηριστικού για τον τύπο λίστας επιλογών Ένα αντικείμενο επιστρέφεται με τις ακόλουθες ιδιότητες εκτός από τις ιδιότητες τύπου μετα-δεδομένων βασικού χαρακτηριστικού: DefaultFormValue: Αριθμός. Προεπιλεγμένη τιμή φόρμας για το χαρακτηριστικό. OptionSet: Αντικείμενο. Επιλογές για το χαρακτηριστικό όπου κάθε επιλογή είναι ένα ζεύγος κλειδιού:τιμής. Μετα-δεδομένα χαρακτηριστικού για τον τύπο κατάστασης Ένα αντικείμενο επιστρέφεται με τις ακόλουθες ιδιότητες εκτός από τις ιδιότητες τύπου μετα-δεδομένων βασικού χαρακτηριστικού: OptionSet: Αντικείμενο. Επιλογές για το χαρακτηριστικό όπου κάθε επιλογή είναι ένα ζεύγος κλειδιού:τιμής. Το αντικείμενο περιέχει επίσης τις ακόλουθες μεθόδους: getDefaultStatus(arg): Επιστρέφει την προεπιλεγμένη κατάσταση (αριθμός) με βάση την τιμή κατάστασης μεταβίβασης για μια οντότητα. Για προεπιλεγμένες τιμές κατάστασης και κατάστασης για μια οντότητα, ανατρέξτε στην ενότητα πληροφορίες μετα-δεδομένων οντότητας της οντότητας στην αναφορά οντότητας. getStatusValuesForState(arg): Επιστρέφει πιθανές τιμές κατάστασης (πίνακας αριθμών) για μια καθορισμένη τιμή κατάστασης. Για τιμές κατάστασης και κατάστασης για μια οντότητα, ανατρέξτε στην ενότητα πληροφορίες μετα-δεδομένων οντότητας της οντότητας στην αναφορά οντότητας. Μετα-δεδομένα χαρακτηριστικού για τον τύπο κατάστασης Ένα αντικείμενο επιστρέφεται με τις ακόλουθες ιδιότητες εκτός από τις ιδιότητες τύπου μετα-δεδομένων βασικού χαρακτηριστικού: OptionSet: Αντικείμενο. Επιλογές για το χαρακτηριστικό όπου κάθε επιλογή είναι ένα ζεύγος κλειδιού:τιμής. Το αντικείμενο περιέχει επίσης την ακόλουθη μέθοδο: getState(arg): Επιστρέφει την τιμή κατάστασης (αριθμός) για την καθορισμένη τιμή κατάστασης (αριθμός). Για προεπιλεγμένες τιμές κατάστασης και κατάστασης για μια οντότητα, ανατρέξτε στην ενότητα πληροφορίες μετα-δεδομένων οντότητας της οντότητας στην αναφορά οντότητας.

Παραδείγματα

// 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)
    });