INPUT_OBJECT

RollupPropertyParams

Definition of a rollup field: which related records it aggregates and with which function.

link GraphQL Schema definition

  • input RollupPropertyParams {
  • # Relation the rollup follows to reach the related records: the name of an entity
  • # relation, or the id of the lookup field on the source entity for a custom
  • # relation.
  • entityRelationId: ID
  • # Entity kind whose related records are aggregated by this rollup.
  • targetEntity: EntityNameEnum!
  • # API name of the target custom entity, set when targetEntity is a custom entity.
  • entityApiName: String
  • # How related values are combined — Count, Average, Sum, First, Last, Min or Max.
  • aggregationFunction: RollupFieldAggregationFunctionEnum!
  • # Id of the field whose values are aggregated; null for Count, and for First and
  • # Last when the whole related record is returned.
  • fieldId: ID
  • # Field-condition filter selecting which related records are aggregated.
  • filter: FieldFilterParams
  • # Id of the field the related records are sorted by to pick the First or Last one.
  • sortFieldId: ID
  • }