flowaggregation EntityType
- Entity set path:
- [organization URI]/api/data/v9.2/flowaggregations
- Base type:
- crmbaseentity
- Display name:
- Flow Aggregation
- Primary key:
- flowaggregationid
- 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 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| aggregationtype | Edm.String |
Display name: Aggregation Type |
||||||||
| aggregationvalue | Edm.Int64 |
Display name: Aggregation value |
||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display name: Created On Read only
|
||||||||
| errorcode | Edm.String |
Display name: Error Code |
||||||||
| flowaggregationid | Edm.Guid |
Unique identifier for entity instances Display name: flowaggregation |
||||||||
| importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display name: Import Sequence Number |
||||||||
| istoplevelrun | Edm.Boolean |
Display name: Is Top Level Run
Default options
|
||||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the record was modified. Display name: Modified On Read only
|
||||||||
| name | Edm.String |
Display name: Name |
||||||||
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display name: Record Created On |
||||||||
| partitionid | Edm.String |
Logical partition id. A logical partition consists of a set of records with same partition id. Display name: Partition Id |
||||||||
| status | Edm.String |
Display name: Status |
||||||||
| timeend | Edm.DateTimeOffset |
Display name: Time End |
||||||||
| timestart | Edm.DateTimeOffset |
Display name: Time Start |
||||||||
| triggertype | Edm.String |
Display name: TriggerType |
||||||||
| ttlinseconds | Edm.Int32 |
Time to live in seconds. Display name: Time to live |
||||||||
| value | Edm.Int64 |
Display name: Value |
||||||||
| versionnumber | Edm.Int64 |
Version Number Display name: Version Number Read only
|
||||||||
| workflowcategory | Edm.Int32 |
Display name: WorkflowCategory
Default options
|
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. |
| _workflowid_value | workflowid |
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_flowaggregation_createdby |
| createdonbehalfby | systemuser | lk_flowaggregation_createdonbehalfby |
| modifiedby | systemuser | lk_flowaggregation_modifiedby |
| modifiedonbehalfby | systemuser | lk_flowaggregation_modifiedonbehalfby |
| ownerid | principal | owner_flowaggregation |
| owningbusinessunit | businessunit | business_unit_flowaggregation |
| owningteam | team | team_flowaggregation |
| owninguser | systemuser | user_flowaggregation |
| workflowid | workflow | workflow_flowaggregation_workflowid |
Operations
The following operations can be used with the flowaggregation entity type.
| Name | Binding |
|---|---|
| CreateMultiple | Not Bound |
| DeleteMultiple | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| UpdateMultiple | Not Bound |
| UpsertMultiple | Not Bound |