rollupfield EntityType
Field to be rolled up to calculate the actual and in-progress values against the goal.
- Entity set path:
- [organization URI]/api/data/v9.2/rollupfields
- Base type:
- crmbaseentity
- Table type:
- Standard
- Display name:
- Rollup Field
- Primary key:
- rollupfieldid
- 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 |
Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options. Display name: Created On Read only
|
||||||
| dateattribute | Edm.String |
Select a date field for the selected record type, such as Actual Closed Date for the Opportunity record type. A record participates in the goal rollup, if the selected date falls between the start date and the end date for the goal. Display name: Date Field |
||||||
| entityfordateattribute | Edm.String |
Select the record type that contains the date field that will be considered while rolling up data to the goal. Display name: Record Type |
||||||
| goalattribute | Edm.String |
Select a rollup field where the metric rollup data will be displayed in the goal. The options are an integer or money, depending on the Metric Type you chose for the goal metric. Display name: Rollup Field |
||||||
| importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display name: Import Sequence Number |
||||||
| isstateparententityattribute | Edm.Boolean |
Tells whether the state or status belongs to the parent entity. Display name: Is State/Status From Parent Entity
Default options
|
||||||
| modifiedon | Edm.DateTimeOffset |
Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options. Display name: Modified On Read only
|
||||||
| rollupfieldid | Edm.Guid |
Unique identifier of the rollup field. Display name: Rollup Field |
||||||
| sourceattribute | Edm.String |
Type the name of the field that the data for the goal rolls up from. Display name: Source Field |
||||||
| sourceentity | Edm.String |
Type the name of the record type (entity) that the data for the goal must roll up from. Display name: Source Record Type |
||||||
| sourcestate | Edm.Int32 |
Select the state of the records you want to use as the source of the rollup data for the metric. Display name: Source Record Type State |
||||||
| sourcestatus | Edm.Int32 |
Select the status of the records you want to use as the source of the rollup data for the metric. Display name: Source Record Type Status |
||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display name: Time Zone Rule Version Number |
||||||
| 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 of the rollup field. 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 |
Shows who created the record. |
| _createdonbehalfby_value | createdonbehalfby |
Shows who created the record on behalf of another user. |
| _metricid_value | metricid |
Unique identifier of the goal metric associated with the rollup field. |
| _modifiedby_value | modifiedby |
Shows who last updated the record. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Shows who last updated the record on behalf of another user. |
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_rollupfield_createdby |
| createdonbehalfby | systemuser | lk_rollupfield_createdonbehalfby |
| metricid | metric | metric_rollupfield |
| modifiedby | systemuser | lk_rollupfield_modifiedby |
| modifiedonbehalfby | systemuser | lk_rollupfield_modifiedonbehalfby |
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 |
|---|---|---|
| rollupfield_AsyncOperations | asyncoperation | regardingobjectid_rollupfield |
| rollupfield_ProcessSessions | processsession | regardingobjectid_rollupfield |
| RollupField_SyncErrors | syncerror | regardingobjectid_rollupfield_syncerror |