Flow Run (flowrun) table/entity reference

Article
08/31/2024

Messages

The following table lists the messages for the Flow Run (flowrun) table. Messages represent operations that can be performed on the table. They may also be events.

Name Is Event?	Web API Operation	SDK for .NET
`Assign` Event: True	`PATCH` /flowruns(flowrunid) Update the `ownerid` property.	AssignRequest
`Create` Event: True	`POST` /flowruns See Create	Create records
`CreateMultiple` Event: True	CreateMultiple	CreateMultipleRequest
`Delete` Event: True	`DELETE` /flowruns(flowrunid) See Delete	Delete records
`DeleteMultiple` Event: True	DeleteMultiple	Learn to use messages with the SDK for .NET
`Retrieve` Event: True	`GET` /flowruns(flowrunid) See Retrieve	Retrieve records
`RetrieveEntityChanges` Event: True		RetrieveEntityChangesRequest
`RetrieveMultiple` Event: True	`GET` /flowruns See Query data	Query data
`RetrievePrincipalAccess` Event: True	RetrievePrincipalAccess	RetrievePrincipalAccessRequest
`Update` Event: True	`PATCH` /flowruns(flowrunid) See Update	Update records
`UpdateMultiple` Event: True	UpdateMultiple	UpdateMultipleRequest
`Upsert` Event: True	`PATCH` /flowruns(flowrunid) See Upsert a table row	UpsertRequest
`UpsertMultiple` Event: True	UpsertMultiple	UpsertMultipleRequest

Properties

The following table lists selected properties for the Flow Run (flowrun) table.

Property	Value
DisplayName	Flow Run
DisplayCollectionName	Flow Runs
SchemaName	`flowrun`
CollectionSchemaName	`flowruns`
EntitySetName	`flowruns`
LogicalName	`flowrun`
LogicalCollectionName	`flowruns`
PrimaryIdAttribute	`flowrunid`
PrimaryNameAttribute	`name`
TableType	`Elastic`
OwnershipType	`UserOwned`

Writable columns/attributes

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

DurationInMs
EndTime
ErrorCode
ErrorMessage
flowrunId
ImportSequenceNumber
IsPrimary
name
OverriddenCreatedOn
OwnerId
OwnerIdType
parentRunId
PartitionId
resourceId
StartTime
Status
TimeZoneRuleVersionNumber
TriggerType
TTLInSeconds
UTCConversionTimeZoneCode
Workflow
WorkflowId

DurationInMs

Property	Value
Description	Duration of the run in milliseconds
DisplayName	Duration
IsValidForForm	True
IsValidForRead	True
LogicalName	`duration`
RequiredLevel	None
Type	BigInt
MaxValue	9223372036854775807
MinValue	-9223372036854775808

EndTime

Property	Value
Description	The date and time at which the flow run ended.
DisplayName	End time
IsValidForForm	True
IsValidForRead	True
LogicalName	`endtime`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Auto
SourceTypeMask	0

ErrorCode

Property	Value
Description	Error code when flow run fails
DisplayName	Error code
IsValidForForm	True
IsValidForRead	True
LogicalName	`errorcode`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

ErrorMessage

Property	Value
Description	Error message when flow run fails
DisplayName	Error message
IsValidForForm	True
IsValidForRead	True
LogicalName	`errormessage`
RequiredLevel	None
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	20000

flowrunId

Property	Value
Description	Unique identifier of flow run
DisplayName	FlowRunId
IsValidForForm	False
IsValidForRead	True
LogicalName	`flowrunid`
RequiredLevel	SystemRequired
Type	Uniqueidentifier

ImportSequenceNumber

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

IsPrimary

Property	Value
Description	Primary run record indicator
DisplayName	IsPrimary
IsValidForForm	True
IsValidForRead	True
LogicalName	`isprimary`
RequiredLevel	None
Type	Picklist
DefaultFormValue	-1
GlobalChoiceName	`flowrun_isprimary`

IsPrimary Choices/Options

Value	Label
0	false
1	true

name

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

OverriddenCreatedOn

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

OwnerId

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

OwnerIdType

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

parentRunId

Property	Value
Description	Unique identifier of the parent run that triggered this run
DisplayName	Parent Run Id
IsValidForForm	False
IsValidForRead	True
LogicalName	`parentrunid`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

PartitionId

Property	Value
Description	Logical partition id. A logical partition consists of a set of records with same partition id.
DisplayName	Partition Id
IsValidForForm	True
IsValidForRead	True
LogicalName	`partitionid`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

resourceId

Property	Value
Description	Unique identifier of the runtime resource
DisplayName	Resource Id
IsValidForForm	False
IsValidForRead	True
LogicalName	`resourceid`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

StartTime

Property	Value
Description	The date and time at which the flow run started
DisplayName	Start time
IsValidForForm	True
IsValidForRead	True
LogicalName	`starttime`
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Auto
SourceTypeMask	0

Status

Property	Value
Description	Status of the flow run
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	`status`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

TimeZoneRuleVersionNumber

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

TriggerType

Property	Value
Description	Type of trigger in the flow run
DisplayName	TriggerType
IsValidForForm	True
IsValidForRead	True
LogicalName	`triggertype`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

TTLInSeconds

Property	Value
Description	Time to live in seconds.
DisplayName	Time to live
IsValidForForm	True
IsValidForRead	True
LogicalName	`ttlinseconds`
RequiredLevel	None
Type	Integer
MaxValue	2147483647
MinValue	1

UTCConversionTimeZoneCode

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

Workflow

Property	Value
Description	Unique identifier of the workflow with which the flow run is associated.
DisplayName	Workflow
IsValidForForm	True
IsValidForRead	True
LogicalName	`workflow`
RequiredLevel	None
Type	Lookup
Targets	workflow

WorkflowId

Property	Value
Description	Unique identifier of the workflow associated with this run
DisplayName	Workflow Id
IsValidForForm	False
IsValidForRead	True
LogicalName	`workflowid`
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

Read-only columns/attributes

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

CreatedBy
CreatedOn
CreatedOnBehalfBy
ModifiedBy
ModifiedOn
ModifiedOnBehalfBy
OwnerIdName
OwnerIdYomiName
OwningBusinessUnit
OwningTeam
OwningUser
VersionNumber

CreatedBy

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

CreatedOn

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

CreatedOnBehalfBy

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
Type	Lookup
Targets	systemuser

ModifiedBy

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

ModifiedOn

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

ModifiedOnBehalfBy

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
Type	Lookup
Targets	systemuser

OwnerIdName

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

OwnerIdYomiName

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

OwningBusinessUnit

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
Type	Lookup
Targets	businessunit

OwningTeam

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

OwningUser

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

VersionNumber

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

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

business_unit_flowrun
lk_flowrun_createdby
lk_flowrun_createdonbehalfby
lk_flowrun_modifiedby
lk_flowrun_modifiedonbehalfby
owner_flowrun
team_flowrun
user_flowrun
workflow_flowrun_Workflow

business_unit_flowrun

One-To-Many Relationship: businessunit business_unit_flowrun

Property	Value
ReferencedEntity	`businessunit`
ReferencedAttribute	`businessunitid`
ReferencingAttribute	`owningbusinessunit`
ReferencingEntityNavigationPropertyName	`owningbusinessunit`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_flowrun_createdby

One-To-Many Relationship: systemuser lk_flowrun_createdby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`createdby`
ReferencingEntityNavigationPropertyName	`createdby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_flowrun_createdonbehalfby

One-To-Many Relationship: systemuser lk_flowrun_createdonbehalfby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`createdonbehalfby`
ReferencingEntityNavigationPropertyName	`createdonbehalfby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_flowrun_modifiedby

One-To-Many Relationship: systemuser lk_flowrun_modifiedby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`modifiedby`
ReferencingEntityNavigationPropertyName	`modifiedby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_flowrun_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_flowrun_modifiedonbehalfby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`modifiedonbehalfby`
ReferencingEntityNavigationPropertyName	`modifiedonbehalfby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

owner_flowrun

One-To-Many Relationship: owner owner_flowrun

Property	Value
ReferencedEntity	`owner`
ReferencedAttribute	`ownerid`
ReferencingAttribute	`ownerid`
ReferencingEntityNavigationPropertyName	`ownerid`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

team_flowrun

One-To-Many Relationship: team team_flowrun

Property	Value
ReferencedEntity	`team`
ReferencedAttribute	`teamid`
ReferencingAttribute	`owningteam`
ReferencingEntityNavigationPropertyName	`owningteam`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

user_flowrun

One-To-Many Relationship: systemuser user_flowrun

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`owninguser`
ReferencingEntityNavigationPropertyName	`owninguser`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

workflow_flowrun_Workflow

One-To-Many Relationship: workflow workflow_flowrun_Workflow

Property	Value
ReferencedEntity	`workflow`
ReferencedAttribute	`workflowid`
ReferencingAttribute	`workflow`
ReferencingEntityNavigationPropertyName	`Workflow`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

flowrun_flowlog_cloudflowrunid

Many-To-One Relationship: flowlog flowrun_flowlog_cloudflowrunid

Property	Value
ReferencingEntity	`flowlog`
ReferencingAttribute	`cloudflowrunid`
ReferencedEntityNavigationPropertyName	`flowrun_flowlog_cloudflowrunid`
IsCustomizable	`False`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `UseCollectionName` Group: `Details` Label: MenuId: null Order: 10000 QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

Share via