flowsession EntityType
Entity to store the information that is generated when a Power Automate Desktop flow runs.
- Entity set path:
- [organization URI]/api/data/v9.2/flowsessions
- Base type:
- crmbaseentity
- Table type:
- Standard
- Display name:
- Flow Session
- Primary key:
- flowsessionid
- Primary name column:
- 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
|
||||||||||||||||||||||||||||||||
| callbackurl | Edm.String |
URL that will be called once the flow session is complete. Display name: Callback URL |
||||||||||||||||||||||||||||||||
| completedon | Edm.DateTimeOffset |
The date and time at which the flow session was completed. Display name: Completed On |
||||||||||||||||||||||||||||||||
| connectionid | Edm.String |
The id of the connection used in the Desktop Flow run. Display name: Connection Id |
||||||||||||||||||||||||||||||||
| 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 |
||||||||||||||||||||||||||||||||
| errorinnererror | Edm.String |
Specific information about the failure in flow session execution. Display name: ErrorInnerError |
||||||||||||||||||||||||||||||||
| 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 |
||||||||||||||||||||||||||||||||
| inputs | Edm.Binary |
Inputs provided for the flow session execution. Display name: Inputs Read only
|
||||||||||||||||||||||||||||||||
| inputs_name | Edm.String |
Read only
|
||||||||||||||||||||||||||||||||
| machinepercentcpuusage | Edm.Double |
The percentage of CPU utilization by the machine Display name: Machine CPU usage percentage |
||||||||||||||||||||||||||||||||
| machinepercentramusage | Edm.Double |
The percentage of RAM utilization by the machine Display name: Machine RAM usage percentage |
||||||||||||||||||||||||||||||||
| machineramusage | Edm.Int32 |
The machine RAM usage in Mo Display name: Machine RAM usage |
||||||||||||||||||||||||||||||||
| 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 |
||||||||||||||||||||||||||||||||
| parentcloudflowrunsequenceid | Edm.String |
The sequence id of the parent cloud flow run, only used when the Desktop Flow was run by a cloud flow. Display name: Parent Cloud Flow Run Sequence Id |
||||||||||||||||||||||||||||||||
| parentworkflowid | Edm.String |
Id of the parent workflow, cloud flow or desktop flow. Display name: ParentWorkflowId |
||||||||||||||||||||||||||||||||
| processversion | Edm.String |
The version of the process with which the flow session is associated. Display name: Process Version |
||||||||||||||||||||||||||||||||
| rundetails | Edm.String |
Details about the run. Display name: RunDetails |
||||||||||||||||||||||||||||||||
| runduration | Edm.Int64 |
Duration of the run. Display name: RunDuration |
||||||||||||||||||||||||||||||||
| runexecutionduration | Edm.Int64 |
Duration of the run execution. Display name: RunExecutionDuration |
||||||||||||||||||||||||||||||||
| runmode | Edm.Int32 |
Indicates the run mode of the desktop flow run. Display name: Run mode
Default options
|
||||||||||||||||||||||||||||||||
| runsessionmode | Edm.Int32 |
Indicates the run session mode of the desktop flow run. Display name: Run session mode
Default options
|
||||||||||||||||||||||||||||||||
| runwaitduration | Edm.Int64 |
Time the run spent waiting. Display name: RunWaitDuration |
||||||||||||||||||||||||||||||||
| sessionusername | Edm.String |
The username used in the Desktop Flow run. Display name: Session Username |
||||||||||||||||||||||||||||||||
| sessionusersid | Edm.String |
The SID of the user used in the Desktop Flow run. Display name: Session User SID |
||||||||||||||||||||||||||||||||
| 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
|
||||||||||||||||||||||||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the FlowSession Display name: Status Reason
Default options
|
||||||||||||||||||||||||||||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display name: Time Zone Rule Version Number |
||||||||||||||||||||||||||||||||
| triggertype | Edm.Int32 |
Indicates the type of trigger used to run the desktop flow. Display name: Trigger type
Default options
|
||||||||||||||||||||||||||||||||
| 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 Lookup property data.
| 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 |
|---|---|---|
| flowevent_flowsession | flowevent | parentobjectid_flowsession |
| flowsession_AsyncOperations | asyncoperation | regardingobjectid_flowsession |
| flowsession_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_flowsession |
| flowsession_FileAttachments | fileattachment | objectid_flowsession |
| flowsession_flowlog_flowsessionid | flowlog | flowsessionid |
| flowsession_flowlog_parentobjectid | flowlog | parentobjectid |
| 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 | Bound to Entity |
| CreateMultiple | Not Bound |
| DeleteMultiple | Not Bound |
| GrantAccess | Not Bound |
| IsValidStateTransition | Not Bound |
| ModifyAccess | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RevokeAccess | Not Bound |
| TriggerDesktopFlowRunCallback | Bound to Entity |
| UpdateMultiple | Not Bound |