gamification.action.update
Scope:
gamificationКто может вызывать: Только admin или manager. Подробнее: Права доступа
Обновить секции и/или элементы каталога действий.
HTTP: POST
Побочные эффекты: изменяет настройки инфоблока каталога действий.
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
sections |
object |
нет | Карта {id: поля} для обновления секций (псевдоним: section) |
elements |
object |
нет | Карта {id: поля} для обновления элементов (псевдоним: element) |
Хотя бы один из параметров должен быть непустым.
Записываются только поля, которые сохраняет вкладка «Действия» настроек модуля:
| Где | Поля |
|---|---|
Раздел (sections) |
в инфоблоке — только активность: ACTIVE (Y/N), для раздела CODE = TASKS — по TASKS_BONUS_ENABLE; ключи настроек модуля TASKS_BONUS_ENABLE, DEPARTMENT |
Элемент (elements) |
NAME, ACTIVE (Y/N), CNT_BALL / PROPERTY_VALUES.CNT_BALL |
Остальные поля игнорируются. Все id должны принадлежать инфоблоку действий модуля, иначе запрос отклоняется целиком (NOT_FOUND) и ничего не записывается.
Возвращаемые данные
result.result — объект с результатами обновления секций и элементов.
Обработка ошибок
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
ACCESS_DENIED |
Вызывающий не является admin/manager |
VALIDATION_ERROR |
sections или elements не является объектом |
NOT_FOUND |
Раздел или элемент не из инфоблока действий модуля (details.sections, details.elements — чужие id) |
Пример запроса (POST)
curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/gamification.action.update.json" \
-H "Content-Type: application/json" \
-d '{
"elements": {
"10": { "POINTS": 10, "ACTIVE": "Y" }
}
}'
Пример ответа:
{
"result": {
"result": {
"sections": {},
"elements": { "10": true }
},
"total": null,
"next": null,
"error": null
}
}
Предыдущая
Следующая