getEntityMetadata (Referència de l'API de JavaScript) per al Dynamics 365 Channel Integration Framework 2.0

Retorna les metadades de l'entitat per a l'entitat especificada.

Sintaxi

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

Paràmetres

Nom Type Obligatori Descripció
entityName Corda Sí El nom lògic de l'entitat.
Atributs Matriu de cadenes No Els atributs per obtenir metadades.

Torna

Tipus: Objecte

Descripció: objecte que conté la informació de metadades de l'entitat amb els atributs següents.

Nom de l'atribut Type Descripció
ActivityTypeMask Nombre Si una activitat personalitzada ha d'aparèixer als menús d'activitat de l'aplicació web. 0 indica que l'activitat personalitzada no es mostra; 1 indica que apareix.
AutoRouteToOwnerQueue booleà Indica si s'han de moure automàticament els registres a la cua per defecte del propietari quan es crea o s'assigna un registre d'aquest tipus.
CanEnableSyncToExternalSearchIndex booleà Només per a ús intern.
CanTriggerWorkflow booleà Indica si l'entitat pot activar un procés de flux de treball.
Descripció Corda Descripció de l'entitat.
DisplayCollectionName Corda Nom de visualització en plural de l'entitat.
Nom de visualització Corda Nom de visualització de l'entitat.
EnforceStateTransitions booleà Indica si l'entitat aplicarà transicions d'estat personalitzades.
EntityColor Corda El codi hexadecimal per representar el color que s'utilitzarà per a aquesta entitat a l'aplicació.
EntitySetName Corda Nom de l'entitat de l'API web definida per a aquesta entitat.
HasActivitats booleà Indica si les activitats estan associades amb aquesta entitat.
ÉsActivitat booleà Indica si l'entitat és una activitat.
IsActivityParty booleà Indica si els missatges de correu electrònic es poden enviar a una adreça electrònica emmagatzemada en un registre d'aquest tipus.
IsBusinessProcessEnabled booleà Indica si l'entitat està habilitada per als fluxos del procés de negoci.
IsBPFEntity booleà Indica si l'entitat és una entitat de flux del procés de negoci.
IsChildEntity booleà Indica si l'entitat és una entitat secundària.
IsConnectionsEnabled booleà Indica si les connexions estan habilitades per a aquesta entitat.
IsCustomEntity booleà Indica si l'entitat és una entitat personalitzada.
ÉsPersonalitzable booleà Indica si l'entitat és personalitzable.
IsDocumentManagementEnabled booleà Indica si l'administració de documents està habilitada.
IsDocumentRecommendationsEnabled booleà Indica si les recomanacions de documents estan habilitades.
IsDuplicateDetectionEnabled booleà Indica si la detecció de duplicats està activada.
IsEnabledForCharts booleà Indica si els gràfics estan habilitats.
ÉsImportable booleà Indica si l'entitat es pot importar mitjançant l'Auxiliar d'importació.
IsInteractionCentricEnabled booleà Indica que l'entitat està habilitada per a l'experiència interactiva.
IsKnowledgeManagementEnabled booleà Indica si l'administració del coneixement està habilitada per a l'entitat.
IsMailMergeEnabled booleà Indica si la combinació de correspondència està habilitada per a aquesta entitat.
Està gestionat booleà Indica si l'entitat forma part d'una solució administrada.
IsOneNoteIntegrationEnabled booleà Indica si la integració del OneNote està habilitada per a l'entitat.
IsOptimisticConcurrencyEnabled booleà Indica si la concurrència optimista està habilitada per a l'entitat.
IsQuickCreateEnabled booleà Indica si l'entitat està habilitada per a formularis de creació ràpida.
IsStateModelAware booleà Indica si l'entitat admet la configuració de transicions d'estat personalitzades.
IsValidForAdvancedFind booleà Indica si l'entitat es mostra a la cerca avançada.
IsVisibleInMobileClient booleà Indica si els usuaris del Microsoft Dynamics 365 per a tauletes poden veure les dades d'aquesta entitat.
IsEnabledInUnifiedInterface booleà Indica si l'entitat està habilitada per a la interfície unificada.
Nom de la col·lecció lògica Corda El nom de la col·lecció lògica.
Nom lògic Corda El nom lògic de l'entitat.
ObjectTypeCode Nombre El codi del tipus d'entitat.
Tipus de propietat Corda El tipus de propietat de l'entitat: "UserOwned" o "OrganizationOwned".
PrimaryIdAttribute Corda Nom de l'atribut que és l'identificador principal de l'entitat.
PrimaryImageAttribute Corda El nom de l'atribut d'imatge principal d'una entitat.
Atribut NomPrimari Corda El nom de l'atribut principal d'una entitat.
Privilegis Matriu d'objectes Les metadades de privilegis de l'entitat on cada objecte conté els atributs següents per definir el privilegi de seguretat per accedir a una entitat:
  • CanBeBasic: Booleà. Si el privilegi pot ser de nivell d'accés bàsic.
  • CanBeDeep: Booleà. Si el privilegi pot ser el nivell d'accés profund.
  • CanBeEntityReference: Booleà. Si el privilegi per a una part externa pot ser el nivell d'accés bàsic.
  • CanBeGlobal: Booleà. Si el privilegi pot ser de nivell d'accés global.
  • CanBeLocal: Booleà. Si el privilegi pot ser de nivell d'accés local.
  • CanBeParentEntityReference: Booleà. Si el privilegi d'una part externa pot ser el nivell d'accés principal.
  • Nom: Cadena. El nom del privilegi.
  • PrivilegeId: cadena. L'identificador del privilegi.
  • PrivilegeType: Número. El tipus de privilegi, que és un dels següents:
    • 0: Cap
    • 1: Crear
    • 2: Llegir
    • 3: Escriu
    • 4: Suprimeix
    • 5: Assignar
    • 6: Comparteix
    • 7: Afegeix
    • 8: AnnexA
Atributs Col·lecció Una col·lecció d'objectes de metadades d'atributs. L'objecte retornat depèn del tipus de metadades d'atribut.

Metadades d'atributs per al tipus base
Un objecte retornat amb les propietats següents:

  • AttributeType: Número. Tipus d'atribut. Per obtenir una llista dels valors de tipus d'atribut, vegeu AttributeTypeCode
  • DisplayName: cadena. Nom de visualització de l'atribut.
  • EntityLogicalName: cadena. Nom lògic de l'entitat que conté l'atribut.
  • LogicalName: cadena. Nom lògic de l'atribut.

Metadades d'atributs per al tipus booleà
Un objecte retornat amb les propietats següents a més de les propietats del tipus de metadades de l'atribut base :

  • DefaultFormValue: Booleà. Valor per defecte d'un conjunt d'opcions booleanes.
  • OptionSet: Objecte. Opcions per a l'atribut booleà on cada opció és un parell clau:valor.

Metadades d'atributs per al tipus d'enumeració
Un objecte retornat amb les propietats següents a més de les propietats del tipus de metadades de l'atribut base :

  • OptionSet: Objecte. Opcions per a l'atribut on cada opció és un parell clau:valor.

Metadades d'atribut per al tipus de llista de selecció
Un objecte retornat amb les propietats següents a més de les propietats del tipus de metadades de l'atribut base :

  • DefaultFormValue: Nombre. Valor de formulari per defecte per a l'atribut.
  • OptionSet: Objecte. Opcions per a l'atribut on cada opció és un parell clau:valor.

Metadades d'atribut per al tipus d'estat
Un objecte retornat amb les propietats següents a més de les propietats del tipus de metadades de l'atribut base :

  • OptionSet: Objecte. Opcions per a l'atribut on cada opció és un parell clau:valor.

L'objecte també conté els mètodes següents:

  • getDefaultStatus(arg): retorna l'estat per defecte (número) basat en el valor d'estat passat per a una entitat. Per obtenir els valors d'estat i estat per defecte d'una entitat, vegeu la informació de metadades de l'entitat a la referència d'entitat.
  • getStatusValuesForState(arg): retorna els possibles valors d'estat (matriu de números) per a un valor d'estat especificat. Per obtenir els valors d'estat i estat d'una entitat, vegeu la informació de metadades de l'entitat a la referència d'entitat.

Metadades d'atribut per al tipus d'estat
Un objecte retornat amb les propietats següents a més de les propietats del tipus de metadades de l'atribut base :

  • OptionSet: Objecte. Opcions per a l'atribut on cada opció és un parell clau:valor.

L'objecte també conté el mètode següent:

  • getState(arg): retorna el valor d'estat (nombre) per al valor d'estat especificat (nombre). Per obtenir els valors d'estat i estat per defecte d'una entitat, vegeu la informació de metadades de l'entitat a la referència d'entitat.

Exemples

// 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)
    });
  • Last updated on