hints.show.reset
Scope:
hintsКто может вызывать:
RestAccess::requireWrite(). Подробнее: Права доступа
Сбрасывает записи просмотра/пропуска страниц подсказок.
HTTP: POST
Побочные эффекты: удаляет строки из ShowTable; инвалидирует кэш рендера (HintsRenderCache) для затронутых страниц и пользователей.
Обязателен хотя бы один scope-параметр: pageIds, userId или userGroupId. Параметры userId и userGroupId взаимоисключающие.
Параметр pageIds — массив ID страниц; alias: ids, pageId (один ID). В form-urlencoded POST массив передаётся как pageIds[0]=94, pageIds[1]=97.
Параметры метода
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
pageIds |
array|int |
нет* | ID страниц (alias: ids, pageId) |
userId |
int |
нет* | Сброс для одного пользователя |
userGroupId |
int |
нет* | Сброс для всех участников группы |
*Нужен хотя бы один из трёх параметров.
Возвращаемые данные
result.result:
| Поле | Тип | Описание |
|---|---|---|
reset |
int | Число удалённых записей |
Все указанные страницы, пользователь и группа должны существовать, иначе метод вернёт VALIDATION_ERROR. Для существующей группы без участников возвращается reset: 0 без ошибки.
Обработка ошибок
Справочник кодов: error-codes.md.
| Код | Описание |
|---|---|
UNAUTHORIZED |
Пользователь не авторизован |
MODULE_DISABLED |
Модуль выключен на сайте |
PERMISSION_DENIED |
Нет права записи (W) |
VALIDATION_ERROR |
Не указан scope; userId и userGroupId вместе; страница, пользователь или группа не найдены |
INTERNAL_ERROR |
Внутренняя ошибка сервера (в т.ч. недоступен UserGroupTable) |
Пример запроса (POST, JSON)
curl -X POST "https://76592.dev.wehive.digital/rest/1/{webhook_code}/hints.show.reset.json" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
--data '{
"pageIds": [94],
"userId": 1
}'
Пример запроса (POST, form-urlencoded массив)
curl -X POST "https://76592.dev.wehive.digital/rest/1/{webhook_code}/hints.show.reset.json" \
-H "Accept: application/json" \
--data-urlencode "pageIds[0]=94" \
--data-urlencode "userId=1"
Пример ответа (успех)
{
"result": {
"result": {
"reset": 1
},
"error": null
},
"time": {
"start": 1788357603,
"finish": 1788357603.023848,
"duration": 0.02384805679321289,
"processing": 0,
"date_start": "2026-09-02T17:00:03+03:00",
"date_finish": "2026-09-02T17:00:03+03:00"
}
}
Пример ответа (ошибка: нет scope)
{
"result": {
"result": null,
"error": {
"code": "VALIDATION_ERROR",
"message": "Укажите pageIds, userId или userGroupId.",
"details": {
"fields": ["pageIds", "userId", "userGroupId"]
}
}
},
"time": {
"start": 1788357586,
"finish": 1788357586.203441,
"duration": 0.20344090461730957,
"processing": 0,
"date_start": "2026-09-02T16:59:46+03:00",
"date_finish": "2026-09-02T16:59:46+03:00"
}
}