COcoevera
Field

Fields.update

Changes fields of the Field record with the given id; fields left out keep their values.

patch/entities/Fields/{id}

Request

Path parameters

idstring uuid required

Id of the Field record to update.

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

namestring

User friendly name for field.

parent_options_field_idstring uuid

For dependent dropdown/radio fields, id of the parent field whose selected value restricts the options shown on this field.

calc_formulastring

Calculated formula used for fields which supports calculation.

default_valuestring

Value pre-filled into this field on newly created records, as text converted to the field type; empty for no default. Accepted only by field types that support a default value.

name_translationsstring binary

Map of locale codes to translated field names (e.g. {"en-US": "First name", "de-DE": "Vorname"}). Empty when no translations are defined.

Example request

{
  "name": "string",
  "parent_options_field_id": "01234567-abcd-dcba-ffff-000000000000",
  "calc_formula": "string",
  "default_value": "string",
  "name_translations": "blob"
}

Response

The changed Field 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",
    "entity_name": "string",
    "api_name": "string",
    "name": "string",
    "use_lang": 1,
    "column_name": "string",
    "column_source": 1,
    "relation_id": "string",
    "relation_with_entity_id": "string",
    "shared_with_field_id": "01234567-abcd-dcba-ffff-000000000000",
    "system_type": 1,
    "type_id": "string",
    "composite_field_id": "01234567-abcd-dcba-ffff-000000000000",
    "data_set_id": "01234567-abcd-dcba-ffff-000000000000",
    "parent_options_field_id": "01234567-abcd-dcba-ffff-000000000000",
    "calc_formula": "string",
    "default_value": "string",
    "sequence_set_id": "01234567-abcd-dcba-ffff-000000000000",
    "sequence_id": "01234567-abcd-dcba-ffff-000000000000",
    "sequence_pattern": "string",
    "source_field_id": "string",
    "source_type_id": "string",
    "translated_name": "string",
    "original_dataset_field_id": "01234567-abcd-dcba-ffff-000000000000",
    "name_translations": "blob",
    "name_translated": "string",
    "primitive_type": "string"
  }
}

Changes

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