Introduction to Nonprofit Cloud
Record Rollup Definitions Metadata API Types
RecordAggregationDefinition
RecordAggregationJoinCondition
RecordAggregationObject
RecordAggregationObjectFilter
Previous Versions
Represents a data aggregation from one object to another object to which it is connected by other objects in the data model. This object is available in API version 59.0 and later.
Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.
Important
create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()
DELETE, GET, HEAD, PATCH, POST, Query
To access this object, you must have the Record Aggregation permission set license and the Record Aggregation Access permission.
Type: picklist
Properties: Filter, Group, Restricted picklist, Sort
Description: Required.
API name of the object from which data is aggregated.
Type: picklist
Properties: Filter, Group, Restricted picklist, Sort
Description: Required.
API name of the object to which data is aggregated.
Type: picklist
Properties: Filter, Group, Restricted picklist, Sort
Description: Required.
Type of the data aggregation.
Possible values:
RecordType: reference
Properties: Filter, Group, Nillable, Sort
Description: Data Processing Engine definition that aggregates data from one record to another.
This field is a relationship field.
Relationship Name: BatchProcessingDefinition
Relationship Type: Lookup
Refers To: BatchCalcJobDefinition
Type: string
Properties: Filter, Group, idLookup, Sort
Description: Required.
The name of the record aggregation definition that’s displayed in the record page.
Type: string
Properties: Create, Group, Nillable
Description: The full name of the associated RecordAggregationDefinition type in Metadata API.
Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
Type: picklist
Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description: The language of the record aggregation definition.
Possible values:
da—Danishde—Germanen_US—Englishes—Spanishes_MX—Spanish (Mexico)fi—Finnishfr—Frenchit—Italianja—Japaneseko—Koreannl_NL—Dutchno—Norwegianpt_BR—Portuguese (Brazil)ru—Russiansv—Swedishth—Thaizh_CN—Chinese (Simplified)zh_TW—Chinese (Traditional)Type: picklist
Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort
Description: The status of the record aggregation definition.
Default value: Draft
Possible values:
ActiveDraftInactive