Брендирование Битрикс24

# changeportaldefaultheme.export.download

Scope: changeportaldefaultheme

Кто может вызывать: Пользователь с правом записи на модуль для siteId (UserHelper::canConfigureBranding). Подробнее: Права доступа

Сформировать ZIP-архив с настройками темы и дополнительным CSS; вернуть метаданные для скачивания

HTTP: GET

Побочные эффекты: создаёт ZIP, регистрирует его в b_file. Возвращённый fileId можно передать в import.apply.

Bitrix REST возвращает JSON-конверт, не бинарный поток. Скачивание — HTTP GET по path.

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

Параметр	Тип	Обяз.	Описание
`siteId`	`string`	нет	ID сайта. По умолчанию — сайт по умолчанию

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

Ответ в конверте модуля: result.result:

Поле	Описание
`fileId`	ID файла в `b_file`
`path`	Веб-путь для скачивания
`name`	`changeportaldefaultheme-export.zip`
`contentType`	`application/zip`
`size`	Размер в байтах

result.error.

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

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

Код	Описание
`UNAUTHORIZED`	Пользователь не авторизован
`ACCESS_DENIED`	Нет права записи на модуль для сайта
`SITE_NOT_FOUND`	Сайт с указанным `siteId` не найден
`INTERNAL_ERROR`	Ошибка формирования или сохранения архива

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

Прогон на портале 76593.dev.wehive.digital, пользователь вебхука 1.

curl -G "https://{портал}/rest/{user_id}/{webhook_code}/changeportaldefaultheme.export.download.json" \
          -H "Accept: application/json" \
          --data-urlencode "siteId=s1"

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

{
          "result": {
            "result": {
              "fileId": 1217,
              "path": "/upload/ithive.changeportaldefaultheme/68a/tll05lilf3pk3h0k08x2kfpmyai65ir8/changeportaldefaultheme-export.zip",
              "name": "changeportaldefaultheme-export.zip",
              "contentType": "application/zip",
              "size": 541
            },
            "error": null
          }
        }