knowledgebase.hash.getByElement

Scope: knowledgebase

Кто может вызывать: IblockRights::elementUserHasRightTo(..., 'element_read') на элемент. Подробнее: Права доступа

Получить публичную ссылку (hash) по ID элемента

HTTP: GET

Побочные эффекты: none

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

Параметр Тип Обяз. Описание
elementId int да ID статьи (элемента инфоблока базы знаний)

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

Ответ в конверте модуля: result.result — объект hash; result.error.

Поля: id, elementId, hash, active, url.

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

Справочник кодов: error-codes.md.

Код Описание
UNAUTHORIZED Пользователь не авторизован
VALIDATION_ERROR Некорректные или неполные параметры
NOT_FOUND Элемент не найден в инфоблоке базы знаний
ACCESS_DENIED Нет прав на чтение элемента
HASH_NOT_FOUND Публичная ссылка для элемента не найдена
INTERNAL_ERROR Внутренняя ошибка сервера

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

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/knowledgebase.hash.getByElement.json" \
          -H "Accept: application/json" \
          --data-urlencode "elementId=501"

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

{
          "result": {
            "result": {
              "id": 10,
              "elementId": 1078,
              "hash": "6a1087684209a9331a6a45f8634fef57",
              "active": true,
              "url": "https://76569.dev.wehive.digital/pub/knowledgebase/show.php?hash=6a1087684209a9331a6a45f8634fef57"
            },
            "error": null
          }
        }

Пример ошибки

{
          "result": {
            "result": null,
            "error": {
              "code": "HASH_NOT_FOUND",
              "message": "Публичный хеш для элемента не найден.",
              "details": {
                "elementId": 1073
              }
            }
          }
        }

См. также

Предыдущая
knowledgebase.hash.delete
Следующая
knowledgebase.hash.setActive