OBJECT

EntityHealthEntity

Health configuration of an account type, defining when accounts of that type are healthy or in critical health.

link GraphQL Schema definition

  • type EntityHealthEntity {
  • # 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
  • # Account type this health configuration applies to.
  • type: AccountTypeEntity
  • # Entity whose records the health configuration evaluates; currently always
  • # Account. Read-only.
  • entityType: BaseEntityTypeEnum!
  • # When false, health is configured but not evaluated for records of this type.
  • isEnabled: Boolean!
  • # Timestamp of the last full health recalculation across all matching records.
  • lastRecalculation: DateTime
  • # Id of the account type.
  • typeId: ID!
  • # Revision when entity was lastly changed.
  • revision: Int
  • # Health configuration: indicator filter definitions for healthy and
  • # critical-health states. Stored as a versioned JSON document; updates create a
  • # new history entry. This payload conforms to the `EntityHealthSettings` JSON
  • # Schema: https://api-doc.coevera.com/schemas/EntityHealthSettings.json
  • settings: EntityHealthSettings!
  • # Progress of the in-flight health recalculation as a percentage (0-100). Null
  • # when no recalculation has been queued.
  • calculationProgress: 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!]!
  • }