Отчеты по API: различия между версиями
Материал из Planfix
Seva (обсуждение | вклад) Нет описания правки |
Seva (обсуждение | вклад) Нет описания правки |
||
| Строка 3: | Строка 3: | ||
* Можно запросить генерацию отчета через [[REST API]] и получить его данные, когда он будет сформирован | * Можно запросить генерацию отчета через [[REST API]] и получить его данные, когда он будет сформирован | ||
Спецификация REST API доступна по [https://help.planfix.com/restapidocs/ ссылке]. | Спецификация REST API доступна по [https://help.planfix.com/restapidocs/ ссылке]. | ||
== Получение данных из отчета по расписанию через REST API == | == Получение данных из отчета по расписанию через REST API == | ||
| Строка 28: | Строка 17: | ||
*Получите данные отчёта по идентификатору новой версии методом '''/report/{id}/save/{saveId}/data'''. | *Получите данные отчёта по идентификатору новой версии методом '''/report/{id}/save/{saveId}/data'''. | ||
== Особенности получения данных == | === Особенности получения данных === | ||
*Сохраненные данные отчета доступны только сотрудникам, которых выберете для отправки. | *Сохраненные данные отчета доступны только сотрудникам, которых выберете для отправки. | ||
*Если отчет большой, то у версии будет несколько частей (чанков/chunks). При получении данных отчета необходимо передавать индекс чанка, чтобы получить все части. Сколько чанков содержит отчет видно в ответе метода '''/report/{id}/save/list'''. | *Если отчет большой, то у версии будет несколько частей (чанков/chunks). При получении данных отчета необходимо передавать индекс чанка, чтобы получить все части. Сколько чанков содержит отчет видно в ответе метода '''/report/{id}/save/list'''. | ||
== Методы генерации отчетов через REST API == | |||
*'''/report/{id}/generate''' — метод запускает генерацию отчета с дефолтными настройками, в ответ возвращает requestId. | |||
*'''/report/status/{requestId}''' — метод проверяет статус формирования отчета по requestId. Если отчет готов возвращается объект ReportSave (аналогично с отчетами по расписанию), данные которого можно получить методом /report/{id}/save/{saveId}/data. | |||
=== Особенности генерации === | |||
*Доступно только на тарифе Корпорация. | |||
*Не чаще чем раз в 10 минут. | |||
*Не больше одного параллельно формируемого ответа. | |||
*Отчет формируется от имени и с доступами того, чей токен авторизации указан в REST API. | |||
== Перейти == | == Перейти == | ||
Версия от 06:52, 2 апреля 2025
В ПланФиксе есть два способа получения данных отчетов по API:
- Можно сформировать отчет по расписанию и получить его данные через REST API
- Можно запросить генерацию отчета через REST API и получить его данные, когда он будет сформирован
Спецификация REST API доступна по ссылке.
Получение данных из отчета по расписанию через REST API
- Создайте повторяющийся отчет.
- Создайте токен авторизации для сотрудника, которому планируете отправлять отчет. Сохраненные данные отчета доступны только сотрудникам, которых выберете для отправки. Для создания токена перейдите в Управление аккаунтом — Доступ к API — REST API — Создать новый токен:
- в поле "Сотрудник / Контакт" укажите сотрудника для получения отчета по расписанию.
- в поле "Разрешенных Scope" укажите report_readonly.
- Получите по REST API список отчетов методом /report/list и найдите идентификатор нужного отчета в ответе (идентификатор отчета можно найти в адресной строке браузера).
- Методом /report/{id}/save/list получите список сохраненных версий выбранного отчета.
- Получите данные отчёта по идентификатору новой версии методом /report/{id}/save/{saveId}/data.
Особенности получения данных
- Сохраненные данные отчета доступны только сотрудникам, которых выберете для отправки.
- Если отчет большой, то у версии будет несколько частей (чанков/chunks). При получении данных отчета необходимо передавать индекс чанка, чтобы получить все части. Сколько чанков содержит отчет видно в ответе метода /report/{id}/save/list.
Методы генерации отчетов через REST API
- /report/{id}/generate — метод запускает генерацию отчета с дефолтными настройками, в ответ возвращает requestId.
- /report/status/{requestId} — метод проверяет статус формирования отчета по requestId. Если отчет готов возвращается объект ReportSave (аналогично с отчетами по расписанию), данные которого можно получить методом /report/{id}/save/{saveId}/data.
Особенности генерации
- Доступно только на тарифе Корпорация.
- Не чаще чем раз в 10 минут.
- Не больше одного параллельно формируемого ответа.
- Отчет формируется от имени и с доступами того, чей токен авторизации указан в REST API.