OBJECT

EntityFitnessIndicatorEntity

Indicator of a fitness configuration: a rule that flags lead or opportunity records needing attention and suggests how to fix them.

link GraphQL Schema definition

  • type EntityFitnessIndicatorEntity {
  • # True when the record is protected against deletion because it must always exist
  • # in the space. Deleting a record that is not protected can still fail on other
  • # checks. Read-only.
  • isDeleteProtected: Boolean!
  • # Unique identifier of entity.
  • id: ID!
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • # Fitness configuration this indicator belongs to.
  • entityFitness: EntityFitnessEntity
  • # Description of what the indicator measures, shown in the UI.
  • description: String!
  • # When true, description is treated as a translation key and localized in the UI.
  • descriptionUseLang: Boolean!
  • # Id of the fitness configuration.
  • entityFitnessId: ID!
  • # Suggested remediation text shown to the user when a record triggers this
  • # indicator.
  • howToFix: String!
  • # When true, howToFix is treated as a translation key and localized in the UI.
  • howToFixUseLang: Boolean!
  • # When false, the indicator is configured but not evaluated for records.
  • isEnabled: Boolean!
  • # Display name of the indicator.
  • name: String!
  • # When true, name is treated as a translation key and localized in the UI;
  • # otherwise the literal text is shown.
  • nameUseLang: Boolean!
  • # Indicator rules. For system indicators contains three thresholds (Notice,
  • # Warning, Error); for custom indicators contains user-defined filter rules. This
  • # payload conforms to the `FitnessIndicatorSettings` JSON Schema:
  • # https://api-doc.coevera.com/schemas/FitnessIndicatorSettings.json
  • settings: FitnessIndicatorSettings!
  • # Rule the indicator evaluates. Custom indicators use user-defined filter rules
  • # and can be deleted; all other values are built-in system indicators with three
  • # threshold rules in settings that cannot be deleted.
  • type: FitnessIndicatorTypeEnum!
  • # Revision when entity was lastly changed.
  • revision: Int
  • # Permissions the current user has on this record, out of the requested ones.
  • #
  • # Arguments
  • # permissions: Permissions to check; the result lists those the
  • # current user has.
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • }

link Require by