OBJECT

EntityScoringFieldRule

link GraphQL Schema definition

  • type EntityScoringFieldRule implements EntityScoringRule {
  • # Unique identifier of the scoring rule.
  • id: UUID!
  • # When false, the rule is configured but does not contribute to the score.
  • isEnabled: Boolean!
  • # Display name of the scoring rule.
  • name: String!
  • # When true, the name is treated as a translation key and localized in the UI;
  • # otherwise the literal name text is shown.
  • useLang: Boolean!
  • # How long the points awarded by this rule remain in effect, measured in
  • # expirationUnit. Applies only when expirationEnabled is true.
  • expiration: Int!
  • # Time unit for the expiration value: hour, day, week, or month.
  • expirationUnit: EntityScoringRuleExpirationUnitEnum!
  • # When true, the points awarded by this rule expire after the configured
  • # expiration period; when false, they remain indefinitely.
  • expirationEnabled: Boolean!
  • # Points added to (or, when negative, subtracted from) the record score each time
  • # the rule matches.
  • score: Int!
  • # When true, the score is multiplied by a per-record factor instead of being added
  • # as a fixed amount.
  • scoreMultiplier: Boolean!
  • # Filter conditions a record must satisfy for the rule to award its score.
  • conditions: EntityScoringRuleFilter!
  • # Numeric field whose value is used as the multiplier when scoreMultiplier is
  • # true.
  • scoreMultiplierFieldId: UUID
  • }

link Require by

This element is not required by anyone