modify
Изменит указанную запись в таблице класса, сбросит связанный кэш, сохранит историю. Изменение может быть запрещено настройками профайла (modify_command|editable на уровне класса/клиентского объекта).
Как указано в описании выше, метод изменяет именно конкретную запись. Система не поддерживает массовое изменение по условиям. Это сделано специально, так как так выше контроль со стороны разработчика и логирования за изменениями. Пока не было задач, для которых потребовалось бы настолько массово провести изменения за короткий срок, что изменение по одной записи (можно в параллели) не подходило бы.
При необходимости такой метод может быть разработан и возможно появится в следующих версиях ядра.
Входные параметры. Интерфейс IAPIQueryParams
id изменяемой записи и те поля, которые вы хотите изменить.
Поля запрещенные для изменения в профайле (editable/server_editable/updateable/server_updateable) будут проигнорированы.
Вы можете указывать и виртуальные поля, такие как sysname, тогда система сама отправится в соответствующий справочник, найдет id этого значения (чаще всего из кэша), подставит его в соответствующее физическое поле.
Применимо для виртуальных полей ссылающихся на справочники.
Система проверит записи на уникальность, согласно настройкам профайла класса/клиентского объекта.
В случае обнаружения неуникальности система вернет ошибку (UserError) recExist (code:105).
Выходные параметры. Интерфейс IAPIResponse/IError
В случае ошибки метод вернет объект ошибки - инстанс UserError/MyError.
В случае успеха метод вернет id измененной записи в объекте data инстанса UserOk (res.data.id).