Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Lead

EntityScorings.update

Modifies EntityScoring or EntityScorings with given id(s)

patch/entities/EntityScorings/{id}

Path parameters

idstring uuid required

ID of EntityScoring to update

Query parameters

validation-levelinteger

Specify validation level of EntityScoring 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, 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.

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

Modification confirmation. Returns resulting EntityScoring

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