метод REST scope: vote

vote.AttachedVote.download

Скачать отчет по голосованию

Кто может выполнять: пользователь с правами чтения голосования

Описание

Метод vote.AttachedVote.download формирует и отдает для скачивания отчет по голосованию в указанном формате.

Особенности метода

Внимание! Этот метод является исключением из общего правила работы с REST API. В отличие от других методов, он возвращает не JSON-объект, а непосредственно содержимое файла с HTTP-заголовками, инициирующими скачивание в браузере.

Из-за этого стандартная функция BX24.callMethod() не может обработать ответ и вызовет ошибку. Для работы с этим методом необходимо выполнять прямой HTTP-запрос, как показано в примере кода на JS.

Параметры

1. Через идентификатор прикрепленного опроса

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

Идентификатор прикрепленного голосования, получить можно методами vote.AttachedVote.get или vote.AttachedVote.getMany

2. Через элемент с опросом

moduleId string обязательный

Идентификатор модуля, возможные значения:
- Im для опроса в чате,
- blog для опроса в ленте

entityType string обязательный

Тип объекта, возможные значения:
- Bitrix\\Vote\\Attachment\\ImMessageConnector для опроса в чате,
- Bitrix\\Vote\\Attachment\\BlogPostConnector для опроса в ленте

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

Идентификатор элемента, возможные значения:
- id сообщения чата с опросом, получить можно методом vote.Integration.Im.send,
- id поста с опросом в ленте, получить можно методом log.blogpost.get

3. Через подписанный идентификатор

signedAttachId string обязательный

Подписанный идентификатор прикрепления, получить можно методом vote.AttachedVote.get, параметр ответа signedAttachId

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

curl -X POST \
-L \
-o **put_file_name**.xls \
-H "Content-Type: application/json" \
-d '{"attachId":**put_attach_id**}' \
"https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/vote.AttachedVote.download"

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

{
    "error": "ATTACH_NOT_FOUND",
    "error_description": "Attach not found"
}
Код Описание Значение
100 Bitrix\Vote\Attach All parameters in the constructor must have real class type Не передан или некорректен обязательный параметр. Передайте attachId, signedAttachId либо связку moduleId + entityType + entityId
ATTACH_NOT_FOUND Attach not found Голосование не найдено
ATTACH_READ_ACCESS_DENIED Attach read access denied Нет прав для участия в голосовании

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

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