Attribute table/entity reference
Note
Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.
Messages
| Message | Web API Operation | SDK Assembly |
|---|---|---|
| RetrieveMultiple | GET [org URI]/api/data/v9.0/attributes See Query Data |
RetrieveMultipleRequest or RetrieveMultiple |
Properties
| Property | Value |
|---|---|
| CollectionSchemaName | Attributes |
| DisplayCollectionName | Attributes |
| DisplayName | Attribute |
| EntitySetName | attributes |
| IsBPFEntity | False |
| LogicalCollectionName | attributes |
| LogicalName | attribute |
| OwnershipType | None |
| PrimaryIdAttribute | attributeid |
| PrimaryNameAttribute | name |
| SchemaName | Attribute |
Writable columns/attributes
These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- AttributeId
- ExternalName
- LogicalName
- ManagedPropertyLogicalName
- ManagedPropertyParentAttributeName
- Name
- PhysicalName
- TableColumnName
AttributeId
| Property | Value |
|---|---|
| Description | Unique identifier of the attribute. |
| DisplayName | Attribute |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | attributeid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
ExternalName
| Property | Value |
|---|---|
| Description | The external name of this attribute. |
| DisplayName | External Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | externalname |
| MaxLength | 128 |
| RequiredLevel | None |
| Type | String |
LogicalName
| Property | Value |
|---|---|
| Description | The logical name of this attribute. |
| DisplayName | Logical Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | logicalname |
| MaxLength | 128 |
| RequiredLevel | SystemRequired |
| Type | String |
ManagedPropertyLogicalName
| Property | Value |
|---|---|
| Description | The managed property logical name of this attribute. |
| DisplayName | Managed Property Logical Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | managedpropertylogicalname |
| MaxLength | 128 |
| RequiredLevel | None |
| Type | String |
ManagedPropertyParentAttributeName
| Property | Value |
|---|---|
| Description | The managed property parent attribute name of this attribute. |
| DisplayName | Managed Property Parent Attribute Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | managedpropertyparentattributename |
| MaxLength | 128 |
| RequiredLevel | None |
| Type | String |
Name
| Property | Value |
|---|---|
| Description | The name of this Attribute. |
| DisplayName | Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | name |
| MaxLength | 128 |
| RequiredLevel | None |
| Type | String |
PhysicalName
| Property | Value |
|---|---|
| Description | The physical name of this attribute. |
| DisplayName | Physical Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | physicalname |
| MaxLength | 128 |
| RequiredLevel | None |
| Type | String |
TableColumnName
| Property | Value |
|---|---|
| Description | The table column name of this attribute. |
| DisplayName | Table Column Name |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | tablecolumnname |
| MaxLength | 128 |
| RequiredLevel | None |
| Type | String |
Read-only columns/attributes
These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.
ComponentState
| Property | Value |
|---|---|
| Description | For internal use only. |
| DisplayName | Component State |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | componentstate |
| RequiredLevel | SystemRequired |
| Type | Picklist |
ComponentState Choices/Options
| Value | Label | Description |
|---|---|---|
| 0 | Published | |
| 1 | Unpublished | |
| 2 | Deleted | |
| 3 | Deleted Unpublished |
OverwriteTime
| Property | Value |
|---|---|
| DateTimeBehavior | UserLocal |
| Description | For internal use only. |
| DisplayName | Record Overwrite Time |
| Format | DateOnly |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | overwritetime |
| RequiredLevel | SystemRequired |
| Type | DateTime |
SolutionId
| Property | Value |
|---|---|
| Description | Unique identifier of the associated solution. |
| DisplayName | Solution |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | solutionid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
VersionNumber
Added by: Metadata Extension Solution
| Property | Value |
|---|---|
| Description | The version number of this attribute. |
| DisplayName | Version Number |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | versionnumber |
| MaxValue | 9223372036854775807 |
| MinValue | -9223372036854775808 |
| RequiredLevel | None |
| Type | BigInt |
One-To-Many Relationships
Listed by SchemaName.
- attribute_solutioncomponentattrconfig
- referencingattribute_relationshipattribute
- referencedattribute_relationshipattribute
attribute_solutioncomponentattrconfig
Added by: Solution Component Configuration Solution
Same as solutioncomponentattributeconfiguration table attribute_solutioncomponentattrconfig Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | solutioncomponentattributeconfiguration |
| ReferencingAttribute | attributeid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | attribute_solutioncomponentattrconfig |
| AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
| CascadeConfiguration | Assign: Cascade Delete: Cascade Merge: NoCascade Reparent: Cascade Share: Cascade Unshare: Cascade |
referencingattribute_relationshipattribute
Added by: Metadata Extension Solution
Same as relationshipattribute table referencingattribute_relationshipattribute Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | relationshipattribute |
| ReferencingAttribute | referencingattributeid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | referencingdattribute_relationshipattribute |
| AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
| CascadeConfiguration | Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
referencedattribute_relationshipattribute
Added by: Metadata Extension Solution
Same as relationshipattribute table referencedattribute_relationshipattribute Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | relationshipattribute |
| ReferencingAttribute | referencedattributeid |
| IsHierarchical | False |
| IsCustomizable | False |
| ReferencedEntityNavigationPropertyName | referencedattribute_relationshipattribute |
| AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
| CascadeConfiguration | Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
See also
About the table reference
Web API Reference
attribute EntityType