update_custom_property
Для создания произвольного свойства элемента или изменения существующего используйте метод item/update_custom_property. Для отправки запроса необходимо право доступа на элемент Редактирование неупомянутых свойств.
С помощью этого метода можно управлять настройками интеграции с flespi (токен flespi, регион дата-центра и конфигурация региона), которые хранятся как произвольные свойства элемента главного пользователя учетной записи. Пошаговая инструкция приведена на странице Настройка токена и региона flespi через API.
Конечная точка
svc=item/update_custom_property¶ms={
"itemId":<long>,
"name":"<text>",
"value":"<text>"
}
Параметры
Запрос должен содержать следующие параметры:
| Название | Описание |
|---|---|
| itemId | ID элемента. |
| name | Имя произвольного свойства. Список произвольных свойств объектов см. в разделе Произвольные свойства. |
| value | Значение произвольного свойства. Чтобы удалить произвольное свойство, передайте пустую строку (""). |
Ответ
Если запрос выполнен успешно, возвращается ответ следующего формата:
{
"n":"<text>", /* имя произвольного свойства */
"v":"<text>" /* значение произвольного свойства */
}
В противном случае возвращается код ошибки.
Коды ошибок
| Код ошибки | Описание |
|---|---|
| 4 | Неверные входные параметры. |
| 6 | Неопределенная ошибка. |
| 7 | Не удалось получить элемент. Возможно, у пользователя нет права Редактирование неупомянутых свойств на этот элемент. Эта же ошибка возвращается во время переноса учетной записи пользователя в другой дата-центр. |