mspp_webform EntityType
Defines the necessary properties and relationships to the other key entities in order to control the initialization of the form within a web portal.
- Entity Set Path
- [organization URI]/api/data/v9.2/mspp_webforms
- Base Type
- crmbaseentity
- Display Name
- Multistep Form
- Primary Key
- mspp_webformid
- 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_authenticationrequired | Edm.Boolean |
Redirect to sign in if the user is anonymous. Display Name: Authentication Required
Default Options
|
||||||||||
| mspp_createdon | Edm.DateTimeOffset |
Shows the date and time when the record was created. Display Name: Created On |
||||||||||
| mspp_editexistingrecordpermitted | Edm.Boolean |
Determines if an existing record can be edited. This setting is ignored If the form mode on the form step is set to edit mode. Otherwise, an edit form wouldn't function properly. Display Name: Edit Existing Record Permitted
Default Options
|
||||||||||
| mspp_editexpiredmessage | Edm.String |
Display Name: Edit Expired Message |
||||||||||
| mspp_editexpiredstatecode | Edm.Int32 |
Display Name: Edit Expired State Code |
||||||||||
| mspp_editexpiredstatuscode | Edm.Int32 |
Display Name: Edit Expired Status Code |
||||||||||
| mspp_editnotpermittedmessage | Edm.String |
Display Name: Edit Not Permitted Message |
||||||||||
| mspp_modifiedon | Edm.DateTimeOffset |
Shows the date and time when the record was modified. Display Name: Modified On |
||||||||||
| mspp_multiplerecordsperuserpermitted | Edm.Boolean |
Display Name: Multiple Records Per User Permitted
Default Options
|
||||||||||
| mspp_name | Edm.String |
The name of the custom entity. Display Name: Name |
||||||||||
| mspp_progressindicatorenabled | Edm.Boolean |
Display Name: Enabled
Default Options
|
||||||||||
| mspp_progressindicatorignorelaststep | Edm.Boolean |
Display Name: Ignore Last Step In Progress Count
Default Options
|
||||||||||
| mspp_progressindicatorposition | Edm.Int32 |
Location of the progress indicator relative to the form Display Name: Position
Default Options
|
||||||||||
| mspp_progressindicatorprependstepnum | Edm.Boolean |
Display Name: Prepend Step Number to Step Title
Default Options
|
||||||||||
| mspp_progressindicatortype | Edm.Int32 |
Display Name: Type
Default Options
|
||||||||||
| mspp_provisionedlanguages | Edm.Int32 |
Display Name: Provisioned Languages |
||||||||||
| mspp_savechangeswarningmessage | Edm.String |
Default message: Your changes have not been saved. To stay on the page so that you can save your changes, click Cancel. Display Name: Save Changes Warning Message |
||||||||||
| mspp_savechangeswarningonclose | Edm.Boolean |
Displays a warning message to the user if they close the browser, or refresh the page, or click the previous button in a multiple step form and they have changes that haven't been saved. Display Name: Display Save Changes Warning On Close
Default Options
|
||||||||||
| mspp_startnewsessiononload | Edm.Boolean |
Display Name: Start New Session On Load
Default Options
|
||||||||||
| mspp_webformid | Edm.Guid |
Unique identifier for entity instances Display Name: Multistep Form |
||||||||||
| statecode | Edm.Int32 |
Status of the Multistep Form Display Name: Status
Default Options
|
||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the Multistep 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_startstep_value | mspp_startstep |
Unique identifier for Form Step associated with Multistep Form. |
| _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_webform_createdby |
| mspp_modifiedby | systemuser | mspp_systemuser_mspp_webform_modifiedby |
| mspp_startstep | mspp_webformstep | mspp_webform_startstep |
| mspp_websiteid | mspp_website | mspp_website_webform |
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_webform_webformmetadata_entityformforcreate | mspp_webformmetadata | mspp_entityformforcreate |
| mspp_webformstep_webform | mspp_webformstep | mspp_webform |
| mspp_webpage_webform | mspp_webpage | mspp_webform |
Operations
The following operations can be used with the mspp_webform 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 |