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.0/rollupfields
Base Type
crmbaseentity
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
Value Label
1 Yes
0 No
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 Retrieve data about lookup properties.

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.

_organizationid_value createdby

Choose the ID of the organization that the record is associated with.

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

Solutions

The following solutions include the rollupfield entity type.

Name Description
System Solution Internal CRM System Solution

See also