mspp_entityformmetadata EntityType
Defines the additional behavior modification logic to augment or override the functionality of form components that is not possible with Dynamics 365 entity and form metadata.
- Entity Set Path
- [organization URI]/api/data/v9.2/mspp_entityformmetadatas
- Base Type
- crmbaseentity
- Display Name
- Basic Form Metadata
- Primary Key
- mspp_entityformmetadataid
- Primary Key Attribute
- mspp_name
- Operations Supported
- POST GET PATCH DELETE
Properties
Properties represent fields of data stored in the entity.Some properties are read-only.
| Name | Type | Details | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| mspp_adddescription | Edm.Boolean |
Display Name: Add Description
Default Options
|
||||||||||||||||||||||||
| mspp_attributelogicalname | Edm.String |
Display Name: Attribute Logical Name |
||||||||||||||||||||||||
| mspp_constantsummaximumtotal | Edm.Int32 |
Display Name: Constant Sum Maximum Total |
||||||||||||||||||||||||
| mspp_constantsumminimumtotal | Edm.Int32 |
Display Name: Constant Sum Minimum Total |
||||||||||||||||||||||||
| mspp_constantsumvalidationerrormessage | Edm.String |
Display Name: Constant Sum Validation Error Message |
||||||||||||||||||||||||
| mspp_controlstyle | Edm.Int32 |
Specifies how the control should be modified or enhanced. Display Name: Control Style
Default Options
|
||||||||||||||||||||||||
| mspp_createdon | Edm.DateTimeOffset |
Shows the date and time when the record was created. Display Name: Created On |
||||||||||||||||||||||||
| mspp_cssclass | Edm.String |
Display Name: CSS Class |
||||||||||||||||||||||||
| mspp_description | Edm.String |
Display Name: Description |
||||||||||||||||||||||||
| mspp_descriptionposition | Edm.Int32 |
Display Name: Position
Default Options
|
||||||||||||||||||||||||
| mspp_entityformmetadataid | Edm.Guid |
Unique identifier for entity instances Display Name: Basic Form Metadata |
||||||||||||||||||||||||
| mspp_fieldisrequired | Edm.Boolean |
Display Name: Field is Required
Default Options
|
||||||||||||||||||||||||
| mspp_geolocationvalidatorerrormessage | Edm.String |
The error message to be displayed when the geolocation validator validation fails. Display Name: Geolocation Validator Error Message |
||||||||||||||||||||||||
| mspp_groupname | Edm.String |
Shows which attributes are to be grouped and rendered as a composite control if the control style is a groupings type such as \"Group Whole Number as Constant Sum.\" Display Name: Group Name |
||||||||||||||||||||||||
| mspp_ignoredefaultvalue | Edm.Boolean |
Display Name: Ignore Default Value
Default Options
|
||||||||||||||||||||||||
| mspp_label | Edm.String |
Display Name: Label |
||||||||||||||||||||||||
| mspp_maxmultiplechoiceselectedcount | Edm.Int32 |
Display Name: Multiple Choice Max Selected Count |
||||||||||||||||||||||||
| mspp_minmultiplechoiceselectedcount | Edm.Int32 |
Display Name: Multiple Choice Minimum Required Selected Count |
||||||||||||||||||||||||
| mspp_modifiedon | Edm.DateTimeOffset |
Shows the date and time when the record was modified. Display Name: Modified On |
||||||||||||||||||||||||
| mspp_multiplechoicevalidationerrormessage | Edm.String |
Display Name: Multiple Choice Validation Error Message |
||||||||||||||||||||||||
| mspp_name | Edm.String |
The name of the custom entity. Display Name: Name |
||||||||||||||||||||||||
| mspp_notes_settings | Edm.String |
Display Name: Notes Settings |
||||||||||||||||||||||||
| mspp_onsavefromattribute | Edm.String |
Use this field, in conjunction with On Save Type = Current User Contact, to map any attribute from the current user’s contact record to this record’s attribute logical name. Display Name: On Save From Attribute |
||||||||||||||||||||||||
| mspp_onsavetype | Edm.Int32 |
Shows the mechanisms for populating a field with a value. Display Name: On Save Type
Default Options
|
||||||||||||||||||||||||
| mspp_onsavevalue | Edm.String |
Display Name: Value |
||||||||||||||||||||||||
| mspp_prepopulatefromattribute | Edm.String |
Use this field, in conjunction with Prepopulate Type = Current User Contact, to map any attribute from the current user’s contact record to this record’s attribute logical name. Display Name: Prepopulate From Attribute |
||||||||||||||||||||||||
| mspp_prepopulatetype | Edm.Int32 |
Shows the mechanisms for populating a field with a value. Display Name: Prepopulate Type
Default Options
|
||||||||||||||||||||||||
| mspp_prepopulatevalue | Edm.String |
The value to prepopulate the field. Display Name: Prepopulate Value |
||||||||||||||||||||||||
| mspp_provisionedlanguages | Edm.Int32 |
Display Name: Provisioned Languages |
||||||||||||||||||||||||
| mspp_randomizeoptionsetvalues | Edm.Boolean |
Display Name: Randomize Option Set Values
Default Options
|
||||||||||||||||||||||||
| mspp_rangevalidationerrormessage | Edm.String |
Display Name: Range Validation Error Message |
||||||||||||||||||||||||
| mspp_rankordernotiesvalidationerrormessage | Edm.String |
Display Name: Rank Order No Ties Validation Error Message |
||||||||||||||||||||||||
| mspp_requiredfieldvalidationerrormessage | Edm.String |
The error message shown when a required field does not contain a value. Display Name: Required Field Validation Error Message |
||||||||||||||||||||||||
| mspp_sectionname | Edm.String |
Display Name: Section Name |
||||||||||||||||||||||||
| mspp_setvalueonsave | Edm.Boolean |
Display Name: Set Value On Save
Default Options
|
||||||||||||||||||||||||
| mspp_subgrid_name | Edm.String |
Display Name: Subgrid Name |
||||||||||||||||||||||||
| mspp_subgrid_settings | Edm.String |
Display Name: Subgrid Settings |
||||||||||||||||||||||||
| mspp_tabname | Edm.String |
Display Name: Tab Name |
||||||||||||||||||||||||
| mspp_timeline_settings | Edm.String |
Display Name: Timeline Settings |
||||||||||||||||||||||||
| mspp_type | Edm.Int32 |
Display Name: Type
Default Options
|
||||||||||||||||||||||||
| mspp_useattributedescriptionproperty | Edm.Boolean |
Display Name: Use Attribute's Description Property
Default Options
|
||||||||||||||||||||||||
| mspp_validationerrormessage | Edm.String |
The error message defined for the validation. Display Name: Validation Error Message |
||||||||||||||||||||||||
| mspp_validationregularexpression | Edm.String |
Adds a regular expression validator with the specified regular expression. Display Name: Validation Regular Expression |
||||||||||||||||||||||||
| mspp_validationregularexpressionerrormessage | Edm.String |
Display Name: Regular Expression Validation Error Message |
||||||||||||||||||||||||
| statecode | Edm.Int32 |
Status of the Basic Form Metadata Display Name: Status
Default Options
|
||||||||||||||||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the Basic Form Metadata Display Name: Status Reason
Default Options
|
Lookup Properties
Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.
| Name | Single-valued navigation property | Description |
|---|---|---|
| _mspp_createdby_value | mspp_createdby |
Shows who created the record. |
| _mspp_entityform_value | mspp_entityform |
Unique identifier for Entity Form associated with Entity Form Metadata. |
| _mspp_entityformforcreate_value | mspp_entityformforcreate | |
| _mspp_modifiedby_value | mspp_modifiedby |
Shows who last updated the record. |
Single-valued navigation properties
Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.
| Name | Type | Partner |
|---|---|---|
| mspp_createdby | systemuser | mspp_systemuser_mspp_entityformmetadata_createdby |
| mspp_entityform | mspp_entityform | mspp_entityformmetadata_entityform |
| mspp_entityformforcreate | mspp_entityform | mspp_entityform_entityformmetadata_entityformforcreate |
| mspp_modifiedby | systemuser | mspp_systemuser_mspp_entityformmetadata_modifiedby |
Operations
The following operations can be used with the mspp_entityformmetadata entity type.
| Name | Binding |
|---|---|
| BulkRetain | Not Bound |
| CreateMultiple | Not Bound |
| PurgeRetainedContent | Not Bound |
| Retain | Not Bound |
| RollbackRetain | Not Bound |
| UpdateMultiple | Not Bound |
| ValidateRetentionConfig | Not Bound |