Add

[POST] …/v1/Field/Add

Создаёт новое дополнительное поле. Все поля, создаваемые через этот метод, сохраняются с флагом is_custom = true.

Входные параметры

Название Тип данных Обязательность Описание
key string Обязательный Ключ поля (уникален в рамках entity_type), не более 30 символов. При сохранении к значению добавляется префикс field_
name string Обязательный Наименование поля
entity_type enum Обязательный Сущность, к которой привязано поле
data_type string Обязательный Тип данных значения поля. Допустимые значения: string, int, decimal, bool
required bool Необязательный Обязательное поле (true) или нет (false). По умолчанию false.

key — проверка уникальности в рамках указанной entity_type; максимальная длина 30 символов; при сохранении поле будет иметь key = field_<key>.

Пример запроса

{
  "key": "customer_vat",
  "name": "ИНН клиента",
  "entity_type": "Account",
  "data_type": "string",
  "required": false
}

Выходные параметры

Название Тип данных Описание
new_id Int64 ID созданного поля (InsertResult)

Пример ответа

{
  "ok": true,
  "result": {
    "new_id": 201
  }
}