RecordAggregationObjectFilter

Represents a filter that is applied to the records of an object in the record aggregation join sequence. This object is available in API version 60.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 

AssociatedObjectField 

  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: API name of the associated object’s field whose value is used to filter the object’s records. The associated object is specified in the record aggregation object.

Operator 

  • Type: picklist

  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update

  • Description: Operator used in the filter expression.

  • Possible values:

    • Contains
    • Equals
    • GreaterThan
    • GreaterThanOrEquals
    • In
    • LessThan
    • LessThanOrEquals
    • NotEquals
    • NotIn

RecordAggregationObjectId 

  • Type: reference

  • Properties: Create, Filter, Group, Sort

  • Description: The record aggregation object with which this record aggregation object filter is associated.

    This field is a relationship field.

  • Relationship Name: RecordAggregationObject

  • Relationship Type: Lookup

  • Refers To: RecordAggregationObject

SequenceNumber 

  • Type: int
  • Properties: Create, Filter, Group, Sort, Update
  • Description: Sequence number of this record aggregation object filter.

Value 

  • Type: string
  • Properties: Create, Filter, Group, Sort, Update
  • Description: Reference value with which the designated field’s values are compared when the filter is applied on the associated object’s records.