flowrun EntityType
- Entity set path:
- [organization URI]/api/data/v9.2/flowruns
- Base type:
- crmbaseentity
- Table type:
- Elastic
- Display name:
- Flow Run
- Primary key:
- flowrunid
- 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 | ||||||
|---|---|---|---|---|---|---|---|---|
| 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
|
||||||
| 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 |
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 |
|---|---|---|
| flowrun_flowlog_cloudflowrunid | flowlog | cloudflowrunid |
Operations
The following operations can be used with the flowrun entity type.
| Name | Binding |
|---|---|
| CreateMultiple | Not Bound |
| DeleteMultiple | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| UpdateMultiple | Not Bound |
| UpsertMultiple | Not Bound |