ComplexAttributeMetadata ComplexType
Contains the metadata for a complex attribute.
Properties
The properties of a complex type contain the structured data of the type.
| Name | Type | Details |
|---|---|---|
| AttributeOf | Edm.String |
The name of the attribute that this attribute extends. |
| AttributeType | AttributeTypeCode |
The type of the attribute. |
| AttributeTypeName | AttributeTypeDisplayName |
The name of the type of the attribute. |
| AutoNumberFormat | Edm.String |
Defines the output string format of an autonumber value. |
| CanBeSecuredForCreate | Edm.Boolean |
Whether field-level security can be applied to prevent a user from adding data to this attribute. |
| CanBeSecuredForRead | Edm.Boolean |
Whether field-level security can be applied to prevent a user from viewing data from this attribute. |
| CanBeSecuredForUpdate | Edm.Boolean |
Whether field-level security can be applied to prevent a user from updating data for this attribute. |
| CanModifyAdditionalSettings | BooleanManagedProperty |
Whether any settings not controlled by managed properties can be changed. |
| ColumnNumber | Edm.Int32 |
Organization-specific ID for the attribute used for auditing. |
| CreatedOn | Edm.DateTimeOffset |
When the column was created. |
| DeprecatedVersion | Edm.String |
The Microsoft Dynamics 365 version that the attribute was deprecated in. |
| Description | Label |
The Label containing the description for the attribute. |
| DisplayName | Label |
A label containing the display name for the attribute. |
| EntityLogicalName | Edm.String |
The logical name of the entity that contains the attribute. |
| ExternalName | Edm.String |
The external name of an object, typically based on it's name in it's original source. |
| HasChanged | Edm.Boolean |
Indicates whether the item of metadata has changed. |
| InheritsFrom | Edm.String |
For internal use only. |
| IntroducedVersion | Edm.String |
A string identifying the solution version that the solution component was added in. |
| IsAuditEnabled | BooleanManagedProperty |
Whether the attribute is enabled for auditing. |
| IsCustomAttribute | Edm.Boolean |
Whether the attribute is a custom attribute. |
| IsCustomizable | BooleanManagedProperty |
Whether the attribute allows customization. |
| IsDataSourceSecret | Edm.Boolean | |
| IsFilterable | Edm.Boolean |
For internal use only. |
| IsGlobalFilterEnabled | BooleanManagedProperty |
For internal use only. |
| IsLogical | Edm.Boolean |
Whether the attribute is a logical attribute. |
| IsManaged | Edm.Boolean |
Whether the attribute is part of a managed solution. |
| IsPrimaryId | Edm.Boolean |
Whether the attribute represents the unique identifier for the record. |
| IsPrimaryName | Edm.Boolean |
Whether the attribute represents the primary attribute for the entity. |
| IsRenameable | BooleanManagedProperty |
Whether the attribute display name can be changed. |
| IsRequiredForForm | Edm.Boolean |
Whether the attribute must be included in a form in a model-driven app. |
| IsRetrievable | Edm.Boolean |
For internal use only. |
| IsSearchable | Edm.Boolean |
For internal use only. |
| IsSecured | Edm.Boolean |
Whether the attribute is secured for field-level security. |
| IsSortableEnabled | BooleanManagedProperty |
For internal use only. |
| IsValidForAdvancedFind | BooleanManagedProperty |
Whether the attribute appears in Advanced Find. |
| IsValidForCreate | Edm.Boolean |
Whether the value can be set when a record is created. |
| IsValidForForm | Edm.Boolean |
Whether the column can be added to a form in a model-driven app. |
| IsValidForGrid | Edm.Boolean |
Whether the attribute can be included in a view. |
| IsValidForRead | Edm.Boolean |
Whether the value can be retrieved. |
| IsValidForUpdate | Edm.Boolean |
Whether the value can be updated. |
| IsValidODataAttribute | Edm.Boolean |
Whether the attribute represents a property that is available in the Web API. |
| LinkedAttributeId | Edm.Guid |
The id of the attribute that is linked between appointments and recurring appointments. |
| LogicalName | Edm.String |
The logical name for the attribute. |
| MetadataId | Edm.Guid |
A unique identifier for the metadata item. |
| ModifiedOn | Edm.DateTimeOffset |
When the column was last modified. |
| RequiredLevel | AttributeRequiredLevelManagedProperty |
The property that determines the data entry requirement level enforced for the attribute. |
| SchemaName | Edm.String |
The schema name for the attribute. |
| Settings | Collection(EntitySetting) |
For internal use only. |
| SourceType | Edm.Int32 |
A value that indicates the source type for a calculated or rollup attribute. |
Derived types
The following complex types inherit from the ComplexAttributeMetadata complex type.
| Name | Description |
|---|---|
| ComplexLookupAttributeMetadata | The definition of a lookup attribute passed to the CreateCustomerRelationships Action Lookup parameter. |
| ComplexBigIntAttributeMetadata | Contains the definition for a BigInt column. |
| ComplexBooleanAttributeMetadata | Contains the definition for a Boolean column. |
| ComplexDateTimeAttributeMetadata | Contains the definition for a DateTime column. |
| ComplexDecimalAttributeMetadata | Contains the definition for a Decimal column. |
| ComplexDoubleAttributeMetadata | Contains the definition for a Double column. |
| ComplexEnumAttributeMetadata | Contains the definition for a column that provides choices. |
| ComplexFileAttributeMetadata | Contains the definition for a File column. |
| ComplexImageAttributeMetadata | Contains the definition for an Image column. |
| ComplexIntegerAttributeMetadata | Contains the definition for a Integer column. |
| ComplexManagedPropertyAttributeMetadata | Contains the definition for a ManagedProperty column. |
| ComplexMemoAttributeMetadata | Contains the definition for a Memo column. |
| ComplexMoneyAttributeMetadata | Contains the definition for a Money column. |
| ComplexStringAttributeMetadata | Contains the definition for a String column. |
| ComplexUniqueIdentifierAttributeMetadata | Contains the definition for an UniqueIdentifier column. |
Used by
The following use the ComplexAttributeMetadata ComplexType.
| Name | How used |
|---|---|
| ComplexEntityMetadata | Attributes Property |