RecordAggregationDefinition

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

Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules

To access this object, you must have the Record Aggregation permission set license and the Record Aggregation Access permission.

Fields

AggregateFromObject

Type: picklist
Properties: Filter, Group, Restricted picklist, Sort
Description: Required.

API name of the object from which data is aggregated.

AggregateToObject

Type: picklist
Properties: Filter, Group, Restricted picklist, Sort
Description: Required.

API name of the object to which data is aggregated.

AggregationType

Type: picklist
Properties: Filter, Group, Restricted picklist, Sort
Description: Required.

Type of the data aggregation.
Possible values:
- Record

BatchProcessingDefinitionId

Type: 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

Description

Type: textarea
Properties: Filter, Group, Nillable, Sort
Description: The description for this record aggregation definition.

DeveloperName

Type: string
Properties: Filter, Group, Sort
Description: Unqiue name for the RecordAggregationDefinition object.The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is Record Type Name. This field is automatically generated, but you can supply your own value if you create the record using the API.

DisplayName

Type: string
Properties: Filter, Group, idLookup, Sort
Description: Required.

The name of the record aggregation definition that’s displayed in the record page.

FullName

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.

Language

Type: picklist
Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description: The language of the record aggregation definition.
Possible values:
- da—Danish
- de—German
- en_US—English
- es—Spanish
- es_MX—Spanish (Mexico)
- fi—Finnish
- fr—French
- it—Italian
- ja—Japanese
- ko—Korean
- nl_NL—Dutch
- no—Norwegian
- pt_BR—Portuguese (Brazil)
- ru—Russian
- sv—Swedish
- th—Thai
- zh_CN—Chinese (Simplified)
- zh_TW—Chinese (Traditional)

MasterLabel

Type: string
Properties: Filter, Group, Sort
Description: Label for the record aggregation definition.

Metadata

Type: RecordAggregationDefinition
Properties: Create, Nillable, Update
Description: The RecordAggregationDefinition’s metadata.

Status

Type: picklist
Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort
Description: The status of the record aggregation definition.
Default value: Draft
Possible values:
- Active
- Draft
- Inactive