homepage.about.add

Scope: homepage

Кто может вызывать: Авторизованный пользователь
Описание метода см. в разделе соответствующей подсистемы.
HTTP: POST
Побочные эффекты: изменяет данные

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

Файловые поляФайловые поля

Поля PREVIEW_PICTURE, DETAIL_PICTURE и свойства типа «Файл» принимают содержимое файла: {"base64": "...", "fileName": "icon.png"}, {"data": ["icon.png", "<base64>"]} или, для SVG, {"svg": "<svg ...>"} (разметка или base64); для множественного свойства — список таких значений; удаление файла — {"del": "Y"}. Прочие массивы (например, с ключами tmp_name, name, old_file, VALUE) не принимаются — вернётся VALIDATION_ERROR. Свойства в properties адресуются символьным кодом (CODE) или числовым ID свойства — с одинаковыми проверками; неизвестный ключ свойства — VALIDATION_ERROR. Пустой массив в PREVIEW_PICTURE/DETAIL_PICTURE означает «без изменений». Файлы обрабатываются только после проверки прав на запись в инфоблок. Ссылка на уже сохранённый файл ({"fileId": N} или числовой ID) при создании не принимается — вернётся ACCESS_DENIED.

Права и ограниченияПрава и ограничения

• Метод выполняется от имени вызывающего пользователя: нужно право записи в инфоблок.
• Для помещения элемента в раздел (IBLOCK_SECTION_ID, IBLOCK_SECTION) нужно право привязки элементов к этому разделу, иначе ACCESS_DENIED.
• Поля RIGHTS, CREATED_BY в fields игнорируются: права доступа и автор элемента через REST не меняются.
• SVG проверяется как XML-документ: скрипты, foreignObject, обработчики событий (on*), ссылки javascript: и data:, анимация href запрещены — вернётся INVALID_SVG.
• Если у файлового свойства не задан список допустимых расширений, файлы с активным содержимым (html, htm, xhtml, shtml, xml, xsl, xslt, js, mjs, swf, hta, php, phtml, phar, htaccess) не принимаются — вернётся VALIDATION_ERROR.

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

• result.id - идентификатор созданного элемента.
• total, next - null.
• error - null при успехе.

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

Примеры кодаПримеры кода

Пример запросаПример запроса

curl -G "https://{portal}/rest/{user_id}/{webhook_code}/homepage.about.add.json" \
          -H "Accept: application/json"
        

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

{
          "result": {
            "result": {
              "id": 12345
            },
            "next": null,
            "error": null
          },
          "total": null
        }
        

См. такжеСм. также

• Обзор раздела
• Коды ошибок API