v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Account

EntityHealths.update

Modifies EntityHealth or EntityHealths with given id(s)

patch/entities/EntityHealths/{id}

Path parameters

idstring uuid required

ID of EntityHealth to update

Query parameters

validation-levelinteger

Specify validation level of EntityHealth on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

is_enabledboolean

When false, health is configured but not evaluated for records of this type.

last_recalculationstring date-time

Timestamp of the last full health recalculation across all matching records.

type_idstring uuid

Id of the account type.

revisioninteger

Revision when entity was lastly changed.

settingsstring binary

Health configuration: indicator filter definitions for healthy and critical-health states. Stored as a versioned JSON document; updates create a new history entry.

Example request

{
  "last_recalculation": "2019-01-01T00:00:00",
  "type_id": "01234567-abcd-dcba-ffff-000000000000",
  "revision": 1,
  "settings": "blob"
}

Response

Modification confirmation. Returns resulting EntityHealth

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "entity_type": 1,
    "last_recalculation": "2019-01-01T00:00:00",
    "type_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1,
    "settings": "blob",
    "calculation_progress": 1
  }
}