gamification.rating.create

Scope: gamification

Кто может вызывать: Пользователь с правом на изменение настроек модуля (уровень доступа к модулю выше «чтения»; у администратора портала оно есть всегда). Подробнее: Права доступа

Добавить рейтинг — так же, как ссылка «Добавить рейтинг» на вкладке «Рейтинги» настроек модуля: элемент инфоблока рейтингов создаётся неактивным со значениями по умолчанию (10 мест, 20 уровней отображения, 3 призовых места, весовой коэффициент 0). Как и в настройках, NAME элемента служебный — «Рейтинг N», CODE — его транслитерация (REYTING-N); название, которое видят сотрудники, — свойство RATING_NAME, в него записывается name. Затем переданные fields и arParams сохраняются так же, как в gamification.rating.update. Включить рейтинг — fields.ACTIVE = "Y".

HTTP: POST

Побочные эффекты: новый элемент инфоблока рейтингов; обработчик модуля обновляет агенты пересчёта рейтингов; при arParams — запись параметров стратегии. Если сохранить fields / arParams не удалось, созданный рейтинг удаляется.

Параметры метода

Параметр Тип Обяз. Описание
name string да Название рейтинга для сотрудников — сохраняется в свойство RATING_NAME (в ответе RATING_NAME_VALUE). Если в fields.PROPERTY_VALUES.RATING_NAME передано своё значение, используется оно. Псевдоним: NAME
fields object нет Поля и свойства рейтинга, как в gamification.rating.update: NAME, CODE, ACTIVE, PREVIEW_TEXT, SORT, PROPERTY_VALUES (LOGIC_FOLDER, RATING_NAME, PUBLISH, DEPARTMENT, DEPARTMENT_VIEW, …)
arParams object нет Параметры стратегии рейтинга (сохраняются в каталог стратегии LOGIC_FOLDER)

Возвращаемые данные

result.result — рейтинг в формате gamification.rating.get (поля элемента и arParams).

Обработка ошибок

Справочник кодов ошибок.

Код Описание
UNAUTHORIZED Пользователь не авторизован
ACCESS_DENIED Нет права на изменение настроек модуля
VALIDATION_ERROR Не передан name; fields / arParams не объект; LOGIC_FOLDER не пустой и не код стратегии (details.field = fields.PROPERTY_VALUES.LOGIC_FOLDER, рейтинг не создаётся); не удалось сохранить поля или arParams
INTERNAL_ERROR Инфоблок рейтингов не настроен

Пример запроса (POST)

curl -X POST "https://{портал}/rest/{user_id}/{webhook_code}/gamification.rating.create.json" \
          -H "Content-Type: application/json" \
          -d '{"name": "Лучший наставник", "fields": {"PREVIEW_TEXT": "Рейтинг наставников квартала"}}'

Пример ответа:

{
          "result": {
            "result": {
              "ID": "915",
              "NAME": "Рейтинг 8",
              "ACTIVE": "N",
              "CODE": "REYTING-8",
              "RATING_NAME_VALUE": "Лучший наставник",
              "PREVIEW_TEXT": "Рейтинг наставников квартала",
              "COEF_PARAMETRA_VALUE": "0",
              "arParams": []
            },
            "total": null,
            "next": null,
            "error": null
          }
        }

См. также

Предыдущая
gamification.rating.get
Следующая
gamification.rating.update