/api/v2/bpm/editor/nodes/fieldName
Метод создает имя-ключ для ноды в справочнике
Стоит отметить, что для элементов системы типа "Поле" "nodeType: 3" имя поля крайне важно. Так как приложения-клиенты используют его для отправки на сервер данных для сохранения
- application/json
Request Body
- fieldName string required
Possible values:
non-empty
and<= 255 characters
Имя переменной, которая будет привязываться к ноде (чаще к ноде типа 'поле')
- personalData boolean
Флаг указывающий, что эта переменная принимает персональные данные пользователя приложения. 'true' - значение переменной можно использовать только в момент его получения, 'false' - нет ограничений на хранение значения переменной в базе данных
- localSave boolean
Флаг указывающий, что в эта переменная хранит данные только локально на клиенте
fieldSettings object
Объект содержащий JSON с большим кол-вом настроек для переменной
path stringПозволяет указать путь до значения, которое необходимо сохранить в переменной. Работает только когда parsingType = list. Есть возможность итерировать массивы любой вложенности
type stringТип переменной, которого требует API
regex stringШаблон, который используется для проверки данных из запросов к внешним API по коллбэкам. Если данные запроса не проходят проверку, возвращается ошибка по данным
masking object
Указывает на необходимость и на способ маскирования данных при записи лога
isRequired booleanФлаг указывающий необходимость использовать маски в логах
maskSymbol stringСимвол (маскировочный), на который будут заменяться символы в логах
unmaskedСhars int64Количество символов с конца строки, которые останутся видны в логах
protected booleanФлаг защиты значения переменной от передачи в '/step'. 'true' - изменение переменной происходит только при запросе от внешних сервисов, а передача в '/step' игнорируется 'false' (default) - значение переменной доступно для передачи в '/step'
parsingType stringПараметр определения типа сохранения переменной, 'variable' - просто сохранение. 'list' - перед сохранением происходит переход к нужной переменной в данных согласно пути указанному в 'path'
lifeTime int64Время, которое значение данной переменной считается актуальным и может быть использовано в условиях, функциях и тд.
- 201
- 400
- 401
Created
- application/json
- Schema
- Example (from schema)
- Example
Schema
- object
{}
{
"status": 1,
"message": "FieldName is successfully created",
"response": {
"id": 8991,
"fieldName": "new_fieldname_for_reseach",
"personalData": false,
"localSave": true,
"fieldSettings": {
"type": "json",
"parsingType": "variable"
}
},
"preparingsTime": 0.031
}
Bad Request
- application/json
- Schema
- Example (from schema)
- example-0
- example-1
Schema
- object
{}
400
{
"status": 0,
"message": "Required fieldName",
"response": {},
"preparingsTime": 0.031
}
400_2_dev
{
"status": 0,
"message": {
"fieldName": [
"This field may not be blank."
]
},
"response": {},
"preparingsTime": 0.106
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
- object
{}
{
"status": 0,
"message": "Authentication credentials were not provided.",
"response": {
"detail": "Authentication credentials were not provided."
},
"preparingsTime": 0.003
}