COcoevera
Lead

EntityScorings.update

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

patch/entities/EntityScorings/{id}

Request

Path parameters

idstring uuid required

Id of the EntityScoring 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, the scoring configuration is defined but not evaluated for records.

namestring

Name of the entity and its default text representation.

settingsobject

Entity scoring definition in json format. This payload conforms to the EntityScoringSettings JSON Schema (see the linked schema).

sort_orderinteger

Position of this scoring configuration among others for the same entity type. Configurations are evaluated in this order until one matches.

use_langboolean

When true, the configuration name is treated as a translation key and localized in the UI; otherwise the literal name is shown.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "name": "string",
  "sort_order": 1,
  "revision": 1
}

Response

The changed EntityScoring 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,
    "name": "string",
    "sort_order": 1,
    "revision": 1
  }
}

Changes

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