mspp_entityform EntityType
Defines the form to render for a given entity type.
- Entity Set Path
- [organization URI]/api/data/v9.2/mspp_entityforms
- Base Type
- crmbaseentity
- Display Name
- Basic Form
- Primary Key
- mspp_entityformid
- 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_appendquerystring | Edm.Boolean |
Display Name: Append Query String
Default Options
|
||||||||
| mspp_associatecurrentportaluser | Edm.Boolean |
Display Name: Associate Current Portal User
Default Options
|
||||||||
| mspp_attachfile | Edm.Boolean |
Display Name: Attach File
Default Options
|
||||||||
| mspp_attachfileaccept | Edm.String |
The accept attribute specifies the MIME types of files that the server accepts through file upload. To specify more than one value, separate the values with a comma (e.g. audio/*,video/*,image/*). Display Name: Attach File MIME Type Accept |
||||||||
| mspp_attachfileacceptextensions | Edm.String |
The accept attribute specifies the extension types of files that the server accepts through file upload. To specify more than one value, separate the values with a comma (e.g. .docx,.pdf,.txt). Display Name: Attach File Extension Type Accept |
||||||||
| mspp_attachfileallowmultiple | Edm.Boolean |
Display Name: Attach File Allow Multiple
Default Options
|
||||||||
| mspp_attachfilelabel | Edm.String |
Display Name: Attach File Label |
||||||||
| mspp_attachfilemaxsize | Edm.Int32 |
Display Name: Maximum File Size |
||||||||
| mspp_attachfilerequired | Edm.Boolean |
Display Name: Attach File Required
Default Options
|
||||||||
| mspp_attachfilerequirederrormessage | Edm.String |
Display Name: Attach File Required Error Message |
||||||||
| mspp_attachfilerestrictaccept | Edm.Boolean |
Display Name: Restrict Files To Accepted Types
Default Options
|
||||||||
| mspp_attachfilesaveoption | Edm.Int32 |
Display Name: Attach File Save Option
Default Options
|
||||||||
| mspp_attachfilesizeerrormessage | Edm.String |
Display Name: Attach File Size Error Message |
||||||||
| mspp_attachfilestoragelocation | Edm.Int32 |
Display Name: Attach File Storage Location
Default Options
|
||||||||
| mspp_attachfiletypeerrormessage | Edm.String |
Display Name: Attach File Type Error Message |
||||||||
| mspp_autogeneratesteps | Edm.Boolean |
Display Name: Auto Generate Steps From Tabs
Default Options
|
||||||||
| mspp_captcharequired | Edm.Boolean |
Display Name: Captcha Required
Default Options
|
||||||||
| mspp_createdon | Edm.DateTimeOffset |
Shows the date and time when the record was created. Display Name: Created On |
||||||||
| mspp_entityformid | Edm.Guid |
Unique identifier for entity instances Display Name: Basic Form |
||||||||
| mspp_entityname | Edm.String |
Display Name: Table Name |
||||||||
| mspp_entitypermissionsenabled | Edm.Boolean |
Indicates whether or not the table permission provider will assert privileges. Display Name: Enable Table Permissions
Default Options
|
||||||||
| mspp_entitysourcetype | Edm.Int32 |
Display Name: Table Source Type
Default Options
|
||||||||
| mspp_forceallfieldsrequired | Edm.Boolean |
Display Name: Make All Fields Required
Default Options
|
||||||||
| mspp_formname | Edm.String |
Shows the name of the entity form to render. Display Name: Form Name |
||||||||
| mspp_geolocation_addresslinefieldname | Edm.String |
Display Name: Address Line Field Name |
||||||||
| mspp_geolocation_cityfieldname | Edm.String |
Display Name: City Field Name |
||||||||
| mspp_geolocation_countryfieldname | Edm.String |
Display Name: Country/Region Field Name |
||||||||
| mspp_geolocation_countyfieldname | Edm.String |
Display Name: County Field Name |
||||||||
| mspp_geolocation_displaymap | Edm.Boolean |
Display Name: Display Map
Default Options
|
||||||||
| mspp_geolocation_enabled | Edm.Boolean |
Display Name: Enabled
Default Options
|
||||||||
| mspp_geolocation_formattedaddressfieldname | Edm.String |
Display Name: Formatted Address Field Name |
||||||||
| mspp_geolocation_latitudefieldname | Edm.String |
Display Name: Latitude Field Name |
||||||||
| mspp_geolocation_longitudefieldname | Edm.String |
Display Name: Longitude Field Name |
||||||||
| mspp_geolocation_maptype | Edm.Int32 |
Display Name: Map Type
Default Options
|
||||||||
| mspp_geolocation_neighborhoodfieldname | Edm.String |
Display Name: Neighborhood Field Name |
||||||||
| mspp_geolocation_postalcodefieldname | Edm.String |
Display Name: Zip/Postal Code Field Name |
||||||||
| mspp_geolocation_statefieldname | Edm.String |
Display Name: State or Province Field Name |
||||||||
| mspp_hideformonsuccess | Edm.Boolean |
Display Name: Hide Form on Success
Default Options
|
||||||||
| mspp_instructions | Edm.String |
Display Name: Instructions |
||||||||
| mspp_mode | Edm.Int32 |
Display Name: Mode
Default Options
|
||||||||
| mspp_modifiedon | Edm.DateTimeOffset |
Shows the date and time when the record was modified. Display Name: Modified On |
||||||||
| mspp_name | Edm.String |
The name of the custom entity. Display Name: Name |
||||||||
| mspp_nextbuttoncssclass | Edm.String |
Display Name: Next Button CSS Class |
||||||||
| mspp_nextbuttontext | Edm.String |
Display Name: Next Button Text |
||||||||
| mspp_onsuccess | Edm.Int32 |
Display Name: On Success
Default Options
|
||||||||
| mspp_populatereferenceentitylookupfield | Edm.Boolean |
Display Name: Populate Table Reference Lookup Field
Default Options
|
||||||||
| mspp_portaluserlookupattributeisactivityparty | Edm.Boolean |
Display Name: Is Activity Party
Default Options
|
||||||||
| mspp_previousbuttoncssclass | Edm.String |
Display Name: Previous Button CSS Class |
||||||||
| mspp_previousbuttontext | Edm.String |
Display Name: Previous Button Text |
||||||||
| mspp_primarykeyname | Edm.String |
Display Name: Primary Key Name |
||||||||
| mspp_provisionedlanguages | Edm.Int32 |
Display Name: Provisioned Languages |
||||||||
| mspp_recommendedfieldsrequired | Edm.Boolean |
Display Name: Recommended Fields Required
Default Options
|
||||||||
| mspp_recordidquerystringparametername | Edm.String |
Display Name: Record ID Parameter Name |
||||||||
| mspp_recordnotfoundmessage | Edm.String |
Display Name: Record Not Found Message |
||||||||
| mspp_recordsourceallowcreateonnull | Edm.Boolean |
This flag, when set to \"true,\" allows the user to create a record if the record doesn't already exist and the Record Source Type is \"Record Associated with Current Portal User.\" Display Name: Allow Create If Null
Default Options
|
||||||||
| mspp_recordsourceentitylogicalname | Edm.String |
Display Name: Record Source Table Logical Name |
||||||||
| mspp_recordsourcerelationshipname | Edm.String |
Display Name: Relationship Name |
||||||||
| mspp_redirecturl | Edm.String |
Shows the URL to redirect to. Display Name: Redirect URL |
||||||||
| mspp_redirecturlappendentityidquerystring | Edm.Boolean |
Display Name: Append Table ID To Query String
Default Options
|
||||||||
| mspp_redirecturlcustomquerystring | Edm.String |
Display Name: Custom Query String |
||||||||
| mspp_redirecturlquerystringattribute | Edm.String |
Add an attribute value as a query string value by specifying the logical name of the attribute to assign its value to the query string. Display Name: Attribute Logical Name |
||||||||
| mspp_redirecturlquerystringattributeparamname | Edm.String |
Display Name: Query String Parameter Name |
||||||||
| mspp_redirecturlquerystringname | Edm.String |
The url to redirect to is dynamically retrieved from the query string using this parameter name Display Name: Redirect URL Query String Name |
||||||||
| mspp_referenceentitylogicalname | Edm.String |
Display Name: Reference Table name |
||||||||
| mspp_referenceentityprimarykeylogicalname | Edm.String |
Display Name: Reference Table Primary Key Logical Name |
||||||||
| mspp_referenceentityreadonlyformname | Edm.String |
Display Name: Reference Entity ReadOnly Form Name |
||||||||
| mspp_referenceentityrelationshipname | Edm.String |
Display Name: Reference Entity Relationship Name |
||||||||
| mspp_referenceentityshowreadonlyform | Edm.Boolean |
Display Name: Show Reference Entity ReadOnly Form
Default Options
|
||||||||
| mspp_referenceentitysourcetype | Edm.Int32 |
Display Name: Source Type
Default Options
|
||||||||
| mspp_referencequeryattributelogicalname | Edm.String |
Display Name: Reference Query Attribute Logical Name |
||||||||
| mspp_referencequerystringisprimarykey | Edm.Boolean |
Display Name: Reference Query String Is Primary Key
Default Options
|
||||||||
| mspp_referencequerystringname | Edm.String |
Display Name: Reference Query String Name |
||||||||
| mspp_referencerecordsourcerelationshipname | Edm.String |
Display Name: Record Source Relationship Name |
||||||||
| mspp_referencetargetlookupattributelogicalname | Edm.String |
Display Name: Reference Target Lookup Attribute Logical Name |
||||||||
| mspp_registerstartupscript | Edm.String |
Display Name: Custom JavaScript |
||||||||
| mspp_renderwebresourcesinline | Edm.Boolean |
Display Name: Render Web Resources Inline
Default Options
|
||||||||
| mspp_setentityreference | Edm.Boolean |
Display Name: Set Table Reference
Default Options
|
||||||||
| mspp_settings | Edm.String |
Display Name: Settings |
||||||||
| mspp_showcaptchaforauthenticatedusers | Edm.Boolean |
Display Name: Show Captcha for Authenticated Users
Default Options
|
||||||||
| mspp_showownerfields | Edm.Boolean |
Display Name: Show Owner Fields
Default Options
|
||||||||
| mspp_showunsupportedfields | Edm.Boolean |
Display Name: Show Unsupported Fields
Default Options
|
||||||||
| mspp_submitbuttonbusytext | Edm.String |
Display Name: Submit Button Busy Text |
||||||||
| mspp_submitbuttoncssclass | Edm.String |
Display Name: Submit Button CSS Class |
||||||||
| mspp_submitbuttontext | Edm.String |
Display Name: Submit Button Text |
||||||||
| mspp_successmessage | Edm.String |
Display Name: Success Message |
||||||||
| mspp_tabname | Edm.String |
The name of the tab on an entity form to render. Display Name: Tab Name |
||||||||
| mspp_targetentityportaluserlookupattribute | Edm.String |
Display Name: Portal User Lookup Column |
||||||||
| mspp_tooltipenabled | Edm.Boolean |
Display Name: ToolTip Enabled
Default Options
|
||||||||
| mspp_validationgroup | Edm.String |
Display Name: Validation Group |
||||||||
| mspp_validationsummarycssclass | Edm.String |
Display Name: Validation Summary CSS Class |
||||||||
| mspp_validationsummaryheadertext | Edm.String |
Display Name: Validation Summary Header Text |
||||||||
| mspp_validationsummarylinksenabled | Edm.Boolean |
Display Name: Enable Validation Summary Links
Default Options
|
||||||||
| mspp_validationsummarylinktext | Edm.String |
Display Name: Validation Summary Link Text |
||||||||
| statecode | Edm.Int32 |
Status of the Basic Form Display Name: Status
Default Options
|
||||||||
| statuscode | Edm.Int32 |
Reason for the status of the Basic Form 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_modifiedby_value | mspp_modifiedby |
Shows who last updated the record. |
| _mspp_redirectwebpage_value | mspp_redirectwebpage |
Web Page to redirect to. |
| _mspp_websiteid_value | mspp_websiteid |
Unique identifier for Website entity associated with this 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_entityform_createdby |
| mspp_modifiedby | systemuser | mspp_systemuser_mspp_entityform_modifiedby |
| mspp_redirectwebpage | mspp_webpage | mspp_entityform_redirectwebpage |
| mspp_websiteid | mspp_website | mspp_website_entityform |
Collection-valued navigation properties
Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.
| Name | Type | Partner |
|---|---|---|
| mspp_entityform_entityformmetadata_entityformforcreate | mspp_entityformmetadata | mspp_entityformforcreate |
| mspp_entityform_webformmetadata_entityformforcreate | mspp_webformmetadata | mspp_entityformforcreateinwebformmetadata |
| mspp_entityformmetadata_entityform | mspp_entityformmetadata | mspp_entityform |
| mspp_webpage_entityform | mspp_webpage | mspp_entityform |
Operations
The following operations can be used with the mspp_entityform 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 |