gamification.rating.update
Scope:
gamificationКто может вызывать: Только admin или manager. Подробнее: Права доступа
Обновить поля рейтинга и/или его параметры стратегии (arParams).
HTTP: POST
Побочные эффекты: изменяет запись рейтинга в базе.
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
id |
int |
да | ID рейтинга |
fields |
object |
нет | Поля рейтинга: NAME, CODE, ACTIVE, PREVIEW_TEXT, SORT, PROPERTY_VALUES (коды свойств инфоблока рейтингов). Файловые свойства (ICON) в PROPERTY_VALUES игнорируются — иконка только через img. LOGIC_FOLDER принимается только пустым или равным коду стратегии модуля (gamification.rating.type.list), иначе VALIDATION_ERROR |
arParams |
object |
нет | Параметры стратегии рейтинга |
img |
array |
нет | Иконка в формате файла REST Битрикс24: ["icon.png", "<base64>"] или {"fileData": ["icon.png", "<base64>"]}; jpg, png, gif, webp. URL, путь на сервере и файловый массив не принимаются (псевдоним: ICON) |
Возвращаемые данные
result.result — объект обновлённого рейтинга.
Обработка ошибок
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
ACCESS_DENIED |
Вызывающий не является admin/manager |
VALIDATION_ERROR |
Не передан id; fields или arParams не является объектом; LOGIC_FOLDER не пустой и не код стратегии (details.field = fields.PROPERTY_VALUES.LOGIC_FOLDER); img не файл REST с изображением (details.field = img) |
NOT_FOUND |
Рейтинг не найден |
Пример запроса (POST)
curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/gamification.rating.update.json" \
-H "Content-Type: application/json" \
-d '{"id": 1, "fields": {"STATUS": "active"}}'
Предыдущая
Следующая