COcoevera
Field

Data.create

Creates a Data record.

post/entities/Data

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.

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

data_set_idstring uuid required

Identifier of the data set this option belongs to. Shared by all options of a dropdown / radio / multiselect field.

option_namestring required

Name of the entity and its default text representation.

sort_orderinteger required

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

is_publishedboolean

True when the entity configuration is published; false while it exists only as an unpublished draft.

revisioninteger

Revision when entity was lastly changed.

option_name_translationsstring binary required

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

Example request

{
  "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"
}

Response

The created Data 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",
    "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"
  }
}

Changes

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