Отчеты по API: различия между версиями
Материал из Planfix
Artem (обсуждение | вклад) (Новая страница: «В ПланФиксе можно сформировать отчет по расписанию и получить его данные через REST API. == Получение данных из отчета по расписанию через REST API == *Создайте повторяющийся отчет. *Создайте токен авторизации для сотрудника, которому п...») |
Artem (обсуждение | вклад) Нет описания правки |
||
| (не показано 7 промежуточных версий этого же участника) | |||
| Строка 3: | Строка 3: | ||
== Получение данных из отчета по расписанию через REST API == | == Получение данных из отчета по расписанию через REST API == | ||
*Создайте повторяющийся отчет. | *Создайте повторяющийся отчет. | ||
*Создайте токен авторизации для сотрудника, которому планируете отправлять отчет. Сохраненные данные отчета доступны только сотрудникам, которых выберете для отправки. Для создания токена перейдите в '''Управление аккаунтом''' — '''Доступ к API''' — '''REST API''' — '''Создать новый токен''' | *Создайте токен авторизации для сотрудника, которому планируете отправлять отчет. Сохраненные данные отчета доступны только сотрудникам, которых выберете для отправки. Для создания токена перейдите в '''Управление аккаунтом''' — '''Доступ к API''' — '''REST API''' — '''Создать новый токен''': | ||
https://p.pfx.so/pf/Zq/DTaSBg.png | https://p.pfx.so/pf/Zq/DTaSBg.png | ||
Выбранного сотрудника укажите в поле для получения отчета по расписанию. | |||
*Получите по REST API список отчетов методом '''/report/list''' и найдите идентификатор нужного отчета в ответе (идентификатор отчета можно найти в адресной строке браузера): | |||
https://p.pfx.so/pf/ze/PGDwGM.png | |||
Если отчет большой то у версии будет несколько частей(чанков) | |||
*Методом '''/report/{id}/save/list''' получите список сохраненных версий выбранного отчета: | |||
https://p.pfx.so/pf/Ql/Pa5goU.png | |||
*Получите данные отчёта по идентификатору новой версии методом '''/report/{id}/save/{saveId}/data''': | |||
https://p.pfx.so/pf/AY/1S5NYn.png | |||
== Важно == | |||
*Сохраненные данные отчета доступны только сотрудникам, которых выберете для отправки. | |||
*Если отчет большой, то у версии будет несколько частей (чанков/chunks). При получении данных отчета необходимо передавать индекс чанка, чтобы получить все части. Сколько чанков содержит отчет видно в ответе метода '''/report/{id}/save/list'''. | |||
== Перейти == | |||
*[[Отчет по расписанию]] | |||
*[[Отчеты]] | |||
*[[Описание возможностей]] | |||
Текущая версия от 07:31, 19 сентября 2023
В ПланФиксе можно сформировать отчет по расписанию и получить его данные через REST API.
Получение данных из отчета по расписанию через REST API
- Создайте повторяющийся отчет.
- Создайте токен авторизации для сотрудника, которому планируете отправлять отчет. Сохраненные данные отчета доступны только сотрудникам, которых выберете для отправки. Для создания токена перейдите в Управление аккаунтом — Доступ к API — REST API — Создать новый токен:
Выбранного сотрудника укажите в поле для получения отчета по расписанию.
- Получите по REST API список отчетов методом /report/list и найдите идентификатор нужного отчета в ответе (идентификатор отчета можно найти в адресной строке браузера):
- Методом /report/{id}/save/list получите список сохраненных версий выбранного отчета:
- Получите данные отчёта по идентификатору новой версии методом /report/{id}/save/{saveId}/data:
Важно
- Сохраненные данные отчета доступны только сотрудникам, которых выберете для отправки.
- Если отчет большой, то у версии будет несколько частей (чанков/chunks). При получении данных отчета необходимо передавать индекс чанка, чтобы получить все части. Сколько чанков содержит отчет видно в ответе метода /report/{id}/save/list.