Отчеты по API: различия между версиями
Материал из Planfix
Artem (обсуждение | вклад) |
Artem (обсуждение | вклад) |
||
| Строка 3: | Строка 3: | ||
== Получение данных из отчета по расписанию через REST API == | == Получение данных из отчета по расписанию через REST API == | ||
*Создайте повторяющийся отчет. | *Создайте повторяющийся отчет. | ||
*Создайте токен авторизации для сотрудника, которому планируете отправлять отчет. Сохраненные данные отчета доступны только сотрудникам, которых выберете для отправки. Для создания токена перейдите в '''Управление аккаунтом''' — '''Доступ к API''' — '''REST API''' — '''Создать новый токен'''. | *Создайте токен авторизации для сотрудника, которому планируете отправлять отчет. Сохраненные данные отчета доступны только сотрудникам, которых выберете для отправки. Для создания токена перейдите в '''Управление аккаунтом''' — '''Доступ к API''' — '''REST API''' — '''Создать новый токен'''. | ||
В настройках токена в поле "Разрешенных Scope" укажите report_readonly. | |||
https://p.pfx.so/pf/Zq/DTaSBg.png | https://p.pfx.so/pf/Zq/DTaSBg.png | ||
Версия от 08:04, 28 марта 2025
В ПланФиксе можно сформировать отчет по расписанию и получить его данные через 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.