COcoevera
Account

EntityHealths.batch_create_or_update

Creates or updates EntityHealth records in one request: an item with an id updates that record, an item without one creates a new record.

post/entities/EntityHealths/batch-modify

Request

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.

rollback-method0 | 1

0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

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).

idstring uuid

ID of object to update.

Example request

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

Response

Result per item, in request order: the id of the created or updated record, or the error.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": [
    {
      "http_status": 400,
      "code": 117,
      "name": "ERROR_PARAMETER_INVALID"
    }
  ]
}

Changes

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