v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Data

Data.update

Modifies Data or Data with given id(s)

patch/entities/Data/{id}

Path parameters

idstring uuid required

ID of Data to update

Query parameters

validation-levelinteger

Specify validation level of Data 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

allowed_byobject

For dependent dropdowns, the parent-field values this option is available for, as a JSON array of identifiers (option ids or enum names). Empty when always available.

calc_valuenumber double

Numeric value associated with the option, used in calculation formulas (e.g. score of a dropdown option).

option_namestring

Name of the entity and its default text representation.

sort_orderinteger

Position of the option within its data set; lower values appear first.

revisioninteger

Revision when entity was lastly changed.

option_name_translationsstring binary

Map of locale codes to translated option names (e.g. {"en-US": "Hot", "de-DE": "Heiß"}). Empty when no translations are defined.

Example request

{
  "calc_value": 4.32,
  "option_name": "string",
  "sort_order": 1,
  "revision": 1,
  "option_name_translations": "blob"
}

Response

Modification confirmation. Returns resulting Data

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",
    "calc_value": 4.32,
    "data_set_id": "01234567-abcd-dcba-ffff-000000000000",
    "option_name": "string",
    "sort_order": 1,
    "revision": 1,
    "option_name_translations": "blob",
    "option_name_translated": "string"
  }
}