flowrun EntityType

Entity Set Path
[organization URI]/api/data/v9.2/flowruns
Base Type
crmbaseentity
Display Name
Flow Run
Primary Key
flowrunid
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
createdon Edm.DateTimeOffset

Date and time when the record was created.

Display Name: Created On

Read Only
duration Edm.Int64

Duration of the run in milliseconds

Display Name: Duration

endtime Edm.DateTimeOffset

The date and time at which the flow run ended.

Display Name: End time

errorcode Edm.String

Error code when flow run fails

Display Name: Error code

errormessage Edm.String

Error message when flow run fails

Display Name: Error message

flowrunid Edm.Guid

Unique identifier of flow run

Display Name: FlowRunId

importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

isprimary Edm.Int32

Primary run record indicator

Display Name: IsPrimary

Default Options
Values Label
1 true
0 false
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

overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

parentrunid Edm.String

Unique identifier of the parent run that triggered this run

Display Name: Parent Run Id

partitionid Edm.String

Logical partition id. A logical partition consists of a set of records with same partition id.

Display Name: Partition Id

resourceid Edm.String

Unique identifier of the runtime resource

Display Name: Resource Id

starttime Edm.DateTimeOffset

The date and time at which the flow run started

Display Name: Start time

status Edm.String

Status of the flow run

Display Name: Status

timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

triggertype Edm.String

Type of trigger in the flow run

Display Name: TriggerType

ttlinseconds Edm.Int32

Time to live in seconds.

Display Name: Time to live

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
workflowid Edm.String

Unique identifier of the workflow associated with this run

Display Name: Workflow Id

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.

_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.

_workflow_value Workflow

Unique identifier of the workflow with which the flow run 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_flowrun_createdby
createdonbehalfby systemuser lk_flowrun_createdonbehalfby
modifiedby systemuser lk_flowrun_modifiedby
modifiedonbehalfby systemuser lk_flowrun_modifiedonbehalfby
ownerid principal owner_flowrun
owningbusinessunit businessunit business_unit_flowrun
owningteam team team_flowrun
owninguser systemuser user_flowrun
Workflow workflow workflow_flowrun_Workflow

Operations

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

Name Binding
CreateMultiple Not Bound
RetrievePrincipalAccess Not Bound
UpdateMultiple Not Bound
UpsertMultiple Not Bound

See also