Partilhar via


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
Table type: 
Virtual
Display name: 
Basic Form
Primary key: 
mspp_entityformid
Primary name column: 
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
Values Label
1 Yes
0 No
mspp_associatecurrentportaluser Edm.Boolean

Display name: Associate Current Portal User

Default options
Values Label
1 Yes
0 No
mspp_attachfile Edm.Boolean

Display name: Attach File

Default options
Values Label
1 Yes
0 No
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
Values Label
1 Yes
0 No
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
Values Label
1 Yes
0 No
mspp_attachfilerequirederrormessage Edm.String

Display name: Attach File Required Error Message

mspp_attachfilerestrictaccept Edm.Boolean

Display name: Restrict Files To Accepted Types

Default options
Values Label
1 Yes
0 No
mspp_attachfilesaveoption Edm.Int32

Display name: Attach File Save Option

Default options
Values Label
756150000 Notes
756150001 Portal Comment
mspp_attachfilesizeerrormessage Edm.String

Display name: Attach File Size Error Message

mspp_attachfilestoragelocation Edm.Int32

Display name: Attach File Storage Location

Default options
Values Label
756150000 Note Attachment
756150001 Azure Blob Storage
mspp_attachfiletypeerrormessage Edm.String

Display name: Attach File Type Error Message

mspp_autogeneratesteps Edm.Boolean

Display name: Auto Generate Steps From Tabs

Default options
Values Label
1 Yes
0 No
mspp_captcharequired Edm.Boolean

Display name: Captcha Required

Default options
Values Label
1 Yes
0 No
mspp_containername Edm.String

Display name: Container Name

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
Values Label
1 Yes
0 No
mspp_entitysourcetype Edm.Int32

Display name: Table Source Type

Default options
Values Label
756150001 Query String
756150002 Current Portal User
756150003 Record Associated to Current Portal User
mspp_forceallfieldsrequired Edm.Boolean

Display name: Make All Fields Required

Default options
Values Label
1 Yes
0 No
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
Values Label
1 Yes
0 No
mspp_geolocation_enabled Edm.Boolean

Display name: Enabled

Default options
Values Label
1 Yes
0 No
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
Values Label
756150000 Bing
756150002 Esri
756150001 Google
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
Values Label
1 Yes
0 No
mspp_instructions Edm.String

Display name: Instructions

mspp_maximumnooffiles Edm.Int32

Display name: Maximum No Of Files

mspp_mode Edm.Int32

Display name: Mode

Default options
Values Label
100000000 Insert
100000001 Edit
100000002 ReadOnly
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
Values Label
756150000 Display Success Message
756150001 Redirect
mspp_populatereferenceentitylookupfield Edm.Boolean

Display name: Populate Table Reference Lookup Field

Default options
Values Label
1 Yes
0 No
mspp_portaluserlookupattributeisactivityparty Edm.Boolean

Display name: Is Activity Party

Default options
Values Label
1 Yes
0 No
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
Values Label
1 Yes
0 No
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
Values Label
1 Yes
0 No
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
Values Label
1 Yes
0 No
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
Values Label
1 Yes
0 No
mspp_referenceentitysourcetype Edm.Int32

Display name: Source Type

Default options
Values Label
756150000 Query String
756150001 Record Associated to Current Portal User
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
Values Label
1 Yes
0 No
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
Values Label
1 Yes
0 No
mspp_setentityreference Edm.Boolean

Display name: Set Table Reference

Default options
Values Label
1 Yes
0 No
mspp_settings Edm.String

Display name: Settings

mspp_showcaptchaforauthenticatedusers Edm.Boolean

Display name: Show Captcha for Authenticated Users

Default options
Values Label
1 Yes
0 No
mspp_showownerfields Edm.Boolean

Display name: Show Owner Fields

Default options
Values Label
1 Yes
0 No
mspp_showunsupportedfields Edm.Boolean

Display name: Show Unsupported Fields

Default options
Values Label
1 Yes
0 No
mspp_storageaccountname Edm.String

Display name: Storage Account Name

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
Values Label
1 Yes
0 No
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
Values Label
1 Yes
0 No
mspp_validationsummarylinktext Edm.String

Display name: Validation Summary Link Text

statecode Edm.Int32

Status of the Basic Form

Display name: Status

Default options
Values Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the Basic Form

Display name: Status Reason

Default options
Values Label
1 Active
2 Inactive

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
DeleteMultiple Not Bound
PurgeRetainedContent Not Bound
Retain Not Bound
RollbackRetain Not Bound
UpdateMultiple Not Bound
ValidateRetentionConfig Not Bound

See also