flowsession EntityType

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

Entity Set Path
[organization URI]/api/data/v9.0/flowsessions
Base Type
crmbaseentity
Display Name
Flow Session
Primary Key
flowsessionid
Primary Key Attribute
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
additionalcontext Edm.Binary

Additional context about flow session.

Display Name: AdditionalContext

Read Only
additionalcontext_name Edm.String
Read Only
completedon Edm.DateTimeOffset

The date and time at which the flow session was completed.

Display Name: Completed On

context Edm.String

Context about flow session.

Display Name: Context

correlationid Edm.String

Unique identifier used to correlate between multiple SDK requests and flow executions.

Display Name: CorrelationId

createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
errorcode Edm.String

Error code describing the failure in flow session execution.

Display Name: ErrorCode

errordetails Edm.String

Details of the failure in flow session execution.

Display Name: ErrorDetails

errormessage Edm.String

Message describing the failure in flow session execution.

Display Name: ErrorMessage

flowsessionid Edm.Guid

Unique identifier for entity instances

Display Name: FlowSession

gateway Edm.String

The name of the gateway used.

Display Name: Gateway

importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
name Edm.String

The name of the custom entity.

Display Name: Name

outputs Edm.Binary

Outputs generated by the flow session execution.

Display Name: Outputs

Read Only
outputs_name Edm.String
Read Only
overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

processversion Edm.String

The version of the process with which the flow session is associated.

Display Name: Process Version

startedon Edm.DateTimeOffset

The date and time at which the flow session was started.

Display Name: Started On

statecode Edm.Int32

Status of the FlowSession

Display Name: Status

Default Options
Value Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the FlowSession

Display Name: Status Reason

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

For internal use only.

Display Name: Time Zone Rule Version Number

utcconversiontimezonecode Edm.Int32

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 Retrieve data about lookup properties.

Name Single-valued navigation property Description
_createdby_value createdby

Unique identifier of the user who created the record.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the record.

_machinegroupid_value MachineGroupId
_machineid_value MachineId
_modifiedby_value modifiedby

Unique identifier of the user who modified the record.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who modified the record.

_ownerid_value ownerid

Owner Id

_owningbusinessunit_value owningbusinessunit

Unique identifier for the business unit that owns the record

_owningteam_value owningteam

Unique identifier for the team that owns the record.

_owninguser_value owninguser

Unique identifier for the user that owns the record.

_regardingobjectid_value regardingobjectid_process

Unique identifier of the process with which the flow session is associated.

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
createdby systemuser lk_flowsession_createdby
createdonbehalfby systemuser lk_flowsession_createdonbehalfby
MachineGroupId flowmachinegroup flowmachinegroup_flowsession_MachineGroupId
MachineId flowmachine flowmachine_flowsession_MachineId
modifiedby systemuser lk_flowsession_modifiedby
modifiedonbehalfby systemuser lk_flowsession_modifiedonbehalfby
ownerid principal owner_flowsession
owningbusinessunit businessunit business_unit_flowsession
owningteam team team_flowsession
owninguser systemuser user_flowsession
regardingobjectid_process workflow regardingobjectid_process

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
flowsession_AsyncOperations asyncoperation regardingobjectid_flowsession
flowsession_BulkDeleteFailures bulkdeletefailure regardingobjectid_flowsession
flowsession_FileAttachments fileattachment objectid_flowsession
flowsession_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_flowsession
flowsession_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_flowsession
flowsession_SyncErrors syncerror regardingobjectid_flowsession
flowsession_workflowbinary_FlowSessionId workflowbinary FlowSessionId

Operations

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

Name Binding
CancelDesktopFlowRun Entity
GrantAccess Not Bound
IsValidStateTransition Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound

Solutions

The following solutions include the flowsession entity type.

Name Description
Power Automate Extensions core package

See also