метод REST scope: documentgenerator

documentgenerator.document.enablepublicurl

Включить или выключить публичную ссылку на документ

Кто может выполнять: пользователь с правом на изменение документов

Описание

Метод documentgenerator.document.enablepublicurl включает или выключает публичную ссылку на документ.

Параметры

id integer обязательный

Идентификатор документа.

Получить идентификатор документа можно после создания документа или методом получения списка документов

status integer необязательный

Статус публичной ссылки:
- 1 - включить
- 0 - выключить

По умолчанию 1

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

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"id":51,"status":1}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.document.enablepublicurl

Ответ

HTTP-статус: 200

{
    "result": {
            "publicUrl": "https://mysite.ru/~nULUE"
    },
    "time": {
        "start": 1773913277,
        "finish": 1773913278.018128,
        "duration": 1.0181279182434082,
        "processing": 1,
        "date_start": "2026-03-19T12:41:17+03:00",
        "date_finish": "2026-03-19T12:41:18+03:00",
        "operating_reset_at": 1773913877,
        "operating": 0
    }
}

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

result object

Корневой элемент ответа (подробное описание)

time time

Информация о времени выполнения запроса

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

HTTP-статус: 400

{
    "error": "0",
    "error_description": "Документ не найден"
}
Код Описание Значение
400 100 Bitrix\DocumentGenerator\Document constructor must be is public
400 0 Документ не найден
400 0 You do not have permissions to view documents

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.