adx_webformsession EntityType

Serves as a mechanism to log the occurrence of an incomplete multistep form entry for a given user so they can return and complete it later.

Entity set path: 
[organization URI]/api/data/v9.2/adx_webformsessions
Base type: 
crmbaseentity
Table type: 
Standard
Display name: 
Multistep Form Session
Primary key: 
adx_webformsessionid
Primary name column: 
adx_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
adx_anonymousidentification Edm.String

Display name: Anonymous Identification

adx_currentstepindex Edm.Int32

The index of the current step the user last visited.

Display name: Current Step Index

adx_name Edm.String

Type the name of the custom entity.

Display name: Name

adx_primaryrecordentitykeyname Edm.String

Display name: Primary Record Entity Primary Key Logical Name

adx_primaryrecordentitylogicalname Edm.String

Display name: Primary Record Table name

adx_primaryrecordid Edm.String

Shows the ID of the primary record created by the multistep form. Used to retrieve the appropriate session record.

Display name: Primary Record ID

adx_stephistory Edm.String

History of steps in JSON

Display name: Step History

adx_userhostaddress Edm.String

Display name: User Host Address

adx_useridentityname Edm.String

Display name: User Identity Name

adx_webformsessionid Edm.Guid

Unique identifier for entity instances

Display name: Multistep Form Session

createdon Edm.DateTimeOffset

Shows the date and time when the record was created. The date and time are displayed in the time zone selected in the solution options.

Display name: Created On

Read only
importsequencenumber Edm.Int32

Shows the sequence number of the import that created this record.

Display name: Import Sequence Number

modifiedon Edm.DateTimeOffset

Shows the date and time when the record was updated. The date and time are displayed in the time zone selected in the solution options.

Display name: Modified On

Read only
overriddencreatedon Edm.DateTimeOffset

Shows the date and time when the record was migrated. The date and time are displayed in the time zone selected in the solution options.

Display name: Record Created On

statecode Edm.Int32

Shows the status of the multistep form session.

Display name: Status

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

Select the Multistep Form Session's status.

Display name: Status Reason

Default options
Values Label
1 Active
2 Inactive
timezoneruleversionnumber Edm.Int32

For internal use only.

Display name: Time Zone Rule Version Number

utcconversiontimezonecode Edm.Int32

Shows the time zone code that was in use when the record was created.

Display name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version Number

Display name: Version Number

Read only

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
_adx_contact_value adx_contact

Unique identifier for Contact associated with Multistep Form Session.

_adx_systemuser_value adx_systemuser

Unique identifier for User associated with Multistep Form Session.

_createdby_value createdby

Unique identifier of the user who created the record.

_createdonbehalfby_value createdonbehalfby

Shows who created the record on behalf of another user.

_modifiedby_value modifiedby

Unique identifier of the user who modified the record.

_modifiedonbehalfby_value modifiedonbehalfby

Shows who last updated the record on behalf of another user.

_mspp_webformid_value mspp_webformid

Unique identifier for Web Form associated with Web Form Session.

_mspp_webformstepid_value mspp_webformstepid

Unique identifier for entity instances

_organizationid_value organizationid

Shows the organization.

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
adx_contact contact adx_webformsession_contact
adx_systemuser systemuser adx_webformsession_systemuser
createdby systemuser lk_adx_webformsession_createdby
createdonbehalfby systemuser lk_adx_webformsession_createdonbehalfby
modifiedby systemuser lk_adx_webformsession_modifiedby
modifiedonbehalfby systemuser lk_adx_webformsession_modifiedonbehalfby
mspp_webformid powerpagecomponent powerpagecomponent_mspp_webformid_adx_webformsession
mspp_webformstepid powerpagecomponent powerpagecomponent_mspp_webformstepid_adx_webformsession
organizationid organization organization_adx_webformsession

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
adx_webformsession_AsyncOperations asyncoperation regardingobjectid_adx_webformsession
adx_webformsession_BulkDeleteFailures bulkdeletefailure regardingobjectid_adx_webformsession
adx_webformsession_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_adx_webformsession
adx_webformsession_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_adx_webformsession
adx_webformsession_ProcessSession processsession regardingobjectid_adx_webformsession
adx_webformsession_SyncErrors syncerror regardingobjectid_adx_webformsession

Operations

The following operations can be used with the adx_webformsession entity type.

Name Binding
BulkRetain Not Bound
CreateMultiple Not Bound
DeleteMultiple Not Bound
IsValidStateTransition Not Bound
PurgeRetainedContent Not Bound
Restore Not Bound
Retain Not Bound
RollbackRetain Not Bound
UpdateMultiple Not Bound
ValidateRetentionConfig Not Bound

See also