Custom Entity

EntitySettingses.create

Creates a EntitySettings record.

post/entities/EntitySettingses

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.

Request body

modifiedstring date-time

Last modification time.

createdstring date-time

Creation time.

default_list_columnsstring binary required

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

is_publishedboolean

True when the settings are published; false while they exist only as an unpublished draft.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "modified": "2019-01-01T00:00:00",
  "created": "2019-01-01T00:00:00",
  "default_list_columns": "blob",
  "revision": 1
}

Response

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

Changes

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