v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Custom Entity

EntitySettingses.update

Modifies EntitySettings or EntitySettingses with given id(s)

patch/entities/EntitySettingses/{id}

Path parameters

idstring uuid required

ID of EntitySettings to update

Query parameters

validation-levelinteger

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

default_list_columnsstring binary

Default column configuration applied to list views of this entity (which fields are shown, their widths, frozen state, and whether to push the configuration to existing users).

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "default_list_columns": "blob",
  "revision": 1
}

Response

Modification confirmation. Returns resulting EntitySettings

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",
    "default_list_columns": "blob",
    "revision": 1
  }
}