RecordAggregationJoinCondition

Represents a condition in a join between two record aggregation objects. This object is available in API version 59.0 and later.

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

JoinField

  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: The API name of the field on the record aggregation object's associated object that is used in the join condition.

NavigationSequenceNumber

  • Type: int
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The sequence number corresponding to this join in the join sequence from the object to which the data is aggregated to the object that contains the data being aggregated.

RecordAggregationObjectId

  • Type: reference
  • Properties: Create, Filter, Group, Sort
  • Description: The record aggregation object with which this record aggregation join condition is associated.

    This field is a relationship field.

  • Relationship Name: RecordAggregationObject
  • Relationship Type: Lookup
  • Refers To: RecordAggregationObject

RelatedJoinField

  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: The API name of the field on the related record aggregation object's associated object that is used in the join condition.

RelatedRecordAggrObjectId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The second record aggregation object in the join condition.

    This field is a relationship field.

  • Relationship Name: RelatedRecordAggrObject
  • Relationship Type: Lookup
  • Refers To: RecordAggregationObject

Type

  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: The type of this record aggregation join in the join path from the object to which the data is aggregated to the object that contains the data being aggregated.
  • Possible values:
    • AggregateFrom
    • AggregateTo
    • Intermediate