flowsession table/entity reference

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.

Entity to store the information that is generated when a modern flow or UI flow runs.

Added by: Power Automate Extensions core package Solution

Messages

Message Web API Operation SDK Assembly
Assign PATCH [org URI]/api/data/v9.0/flowsessions(flowsessionid)
Update ownerid property.
AssignRequest
Create POST [org URI]/api/data/v9.0/flowsessions
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/flowsessions(flowsessionid)
See Delete
DeleteRequest or
Delete
GrantAccess GrantAccess Action GrantAccessRequest
IsValidStateTransition IsValidStateTransition Function IsValidStateTransitionRequest
ModifyAccess ModifyAccess Action ModifyAccessRequest
Retrieve GET [org URI]/api/data/v9.0/flowsessions(flowsessionid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/flowsessions
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess Function RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess Function RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccess Action RevokeAccessRequest
SetState PATCH [org URI]/api/data/v9.0/flowsessions(flowsessionid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/flowsessions(flowsessionid)
See Update
UpdateRequest or
Update

Properties

Property Value
CollectionSchemaName flowsessions
DisplayCollectionName Flow Sessions
DisplayName Flow Session
EntitySetName flowsessions
IsBPFEntity False
LogicalCollectionName flowsessions
LogicalName flowsession
OwnershipType UserOwned
PrimaryIdAttribute flowsessionid
PrimaryNameAttribute name
SchemaName flowsession

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

CompletedOn

Property Value
DateTimeBehavior UserLocal
Description The date and time at which the flow session was completed.
DisplayName Completed On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName completedon
RequiredLevel None
Type DateTime

Context

Property Value
Description Context about flow session.
DisplayName Context
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName context
MaxLength 10000
RequiredLevel None
Type Memo

CorrelationId

Property Value
Description Unique identifier used to correlate between multiple SDK requests and flow executions.
DisplayName CorrelationId
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName correlationid
MaxLength 100
RequiredLevel None
Type String

ErrorCode

Property Value
Description Error code describing the failure in flow session execution.
DisplayName ErrorCode
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName errorcode
MaxLength 1000
RequiredLevel None
Type String

ErrorDetails

Property Value
Description Details of the failure in flow session execution.
DisplayName ErrorDetails
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName errordetails
MaxLength 10000
RequiredLevel None
Type Memo

ErrorMessage

Property Value
Description Message describing the failure in flow session execution.
DisplayName ErrorMessage
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName errormessage
MaxLength 10000
RequiredLevel None
Type Memo

flowsessionId

Property Value
Description Unique identifier for entity instances
DisplayName FlowSession
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName flowsessionid
RequiredLevel SystemRequired
Type Uniqueidentifier

Gateway

Property Value
Description The name of the gateway used.
DisplayName Gateway
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName gateway
MaxLength 100
RequiredLevel None
Type String

ImportSequenceNumber

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

MachineGroupId

Property Value
Description
DisplayName Flow Machine Group
IsValidForForm True
IsValidForRead True
LogicalName machinegroupid
RequiredLevel None
Targets flowmachinegroup
Type Lookup

MachineId

Property Value
Description
DisplayName Flow Machine
IsValidForForm True
IsValidForRead True
LogicalName machineid
RequiredLevel None
Targets flowmachine
Type Lookup

Name

Property Value
Description The name of the custom entity.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 100
RequiredLevel ApplicationRequired
Type String

OverriddenCreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

OwnerId

Added by: Active Solution Solution

Property Value
Description Owner Id
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser,team
Type Owner

OwnerIdType

Added by: Active Solution Solution

Property Value
Description Owner Id Type
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

ProcessVersion

Property Value
Description The version of the process with which the flow session is associated.
DisplayName Process Version
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName processversion
MaxLength 4000
RequiredLevel None
Type String

RegardingObjectId

Property Value
Description Unique identifier of the process with which the flow session is associated.
DisplayName Regarding
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName regardingobjectid
RequiredLevel None
Targets workflow
Type Lookup

RegardingObjectTypeCode

Added by: Active Solution Solution

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName regardingobjecttypecode
RequiredLevel None
Type EntityName

StartedOn

Property Value
DateTimeBehavior UserLocal
Description The date and time at which the flow session was started.
DisplayName Started On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName startedon
RequiredLevel None
Type DateTime

statecode

Property Value
Description Status of the FlowSession
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

statecode Choices/Options

Value Label DefaultStatus InvariantName
0 Active 1 Active
1 Inactive 2 Inactive

statuscode

Property Value
Description Reason for the status of the FlowSession
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

statuscode Choices/Options

Value Label State
0 NotSpecified 1
1 Paused 0
2 Running 0
3 Waiting 0
4 Succeeded 0
5 Skipped 0
6 Suspended 0
7 Cancelled 0
8 Failed 0
9 Faulted 0
10 TimedOut 0
11 Aborted 0
12 Ignored 0
13 Deleted 1
14 Terminated 1

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

AdditionalContext_Name

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName additionalcontext_name
MaxLength 200
RequiredLevel None
Type String

CreatedBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the user who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the delegate user who created the record.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

MachineGroupIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName machinegroupidname
MaxLength 100
RequiredLevel None
Type String

MachineIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName machineidname
MaxLength 100
RequiredLevel None
Type String

ModifiedBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the user who modified the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the delegate user who modified the record.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

Outputs_Name

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName outputs_name
MaxLength 200
RequiredLevel None
Type String

OwnerIdName

Added by: Active Solution Solution

Property Value
Description Name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridname
MaxLength 100
RequiredLevel SystemRequired
Type String

OwnerIdYomiName

Added by: Active Solution Solution

Property Value
Description Yomi name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OwningBusinessUnit

Added by: Active Solution Solution

Property Value
Description Unique identifier for the business unit that owns the record
DisplayName Owning Business Unit
IsValidForForm True
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningBusinessUnitName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunitname
MaxLength 100
RequiredLevel SystemRequired
Type String

OwningTeam

Added by: Active Solution Solution

Property Value
Description Unique identifier for the team that owns the record.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Targets team
Type Lookup

OwningUser

Added by: Active Solution Solution

Property Value
Description Unique identifier for the user that owns the record.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

RegardingObjectIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName regardingobjectidname
MaxLength 4000
RequiredLevel None
Type String

RegardingObjectIdYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName regardingobjectidyominame
MaxLength 4000
RequiredLevel None
Type String

VersionNumber

Added by: Active Solution Solution

Property Value
Description Version Number
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

flowsession_SyncErrors

Added by: System Solution Solution

Same as the flowsession_SyncErrors many-to-one relationship for the syncerror table/entity.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName flowsession_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

flowsession_AsyncOperations

Added by: System Solution Solution

Same as the flowsession_AsyncOperations many-to-one relationship for the asyncoperation table/entity.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName flowsession_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

flowsession_MailboxTrackingFolders

Added by: System Solution Solution

Same as the flowsession_MailboxTrackingFolders many-to-one relationship for the mailboxtrackingfolder table/entity.

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName flowsession_MailboxTrackingFolders
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

flowsession_BulkDeleteFailures

Added by: System Solution Solution

Same as the flowsession_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure table/entity.

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName flowsession_BulkDeleteFailures
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

flowsession_PrincipalObjectAttributeAccesses

Added by: System Solution Solution

Same as the flowsession_PrincipalObjectAttributeAccesses many-to-one relationship for the principalobjectattributeaccess table/entity.

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName flowsession_PrincipalObjectAttributeAccesses
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

flowsession_workflowbinary_FlowSessionId

Same as the flowsession_workflowbinary_FlowSessionId many-to-one relationship for the workflowbinary table/entity.

Property Value
ReferencingEntity workflowbinary
ReferencingAttribute flowsessionid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName flowsession_workflowbinary_FlowSessionId
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: NoCascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related table. Listed by SchemaName.

lk_flowsession_createdby

Added by: System Solution Solution

See the lk_flowsession_createdby one-to-many relationship for the systemuser table/entity.

lk_flowsession_createdonbehalfby

Added by: System Solution Solution

See the lk_flowsession_createdonbehalfby one-to-many relationship for the systemuser table/entity.

lk_flowsession_modifiedby

Added by: System Solution Solution

See the lk_flowsession_modifiedby one-to-many relationship for the systemuser table/entity.

lk_flowsession_modifiedonbehalfby

Added by: System Solution Solution

See the lk_flowsession_modifiedonbehalfby one-to-many relationship for the systemuser table/entity.

user_flowsession

Added by: System Solution Solution

See the user_flowsession one-to-many relationship for the systemuser table/entity.

team_flowsession

Added by: System Solution Solution

See the team_flowsession one-to-many relationship for the team table/entity.

business_unit_flowsession

Added by: System Solution Solution

See the business_unit_flowsession one-to-many relationship for the businessunit table/entity.

regardingobjectid_process

Added by: System Solution Solution

See the regardingobjectid_process one-to-many relationship for the workflow table/entity.

flowmachine_flowsession_MachineId

See the flowmachine_flowsession_MachineId one-to-many relationship for the flowmachine table/entity.

flowmachinegroup_flowsession_MachineGroupId

See the flowmachinegroup_flowsession_MachineGroupId one-to-many relationship for the flowmachinegroup table/entity.

See also

About the table reference
Web API Reference
flowsession EntityType