COcoevera
Account

EntityHealths.update

Changes fields of the EntityHealth record with the given id; fields left out keep their values.

patch/entities/EntityHealths/{id}

Request

Path parameters

idstring uuid required

Id of the EntityHealth record to update.

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

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. This payload conforms to the EntityHealthSettings JSON Schema (see the linked schema).

Example request

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

Response

The changed EntityHealth record.

successboolean

True when the request 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
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.