v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Field

Fields.update

Modifies Field or Fields with given id(s)

patch/entities/Fields/{id}

Path parameters

idstring uuid required

ID of Field to update

Query parameters

validation-levelinteger

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

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

A default value for field.

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

Modification confirmation. Returns resulting Field

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