Отчеты по API: различия между версиями

Материал из Planfix
Перейти к: навигация, поиск
Нет описания правки
Нет описания правки
 
(не показано 6 промежуточных версий этого же участника)
Строка 8: Строка 8:




*Получите по REST API список отчетов методом /report/list и найдите идентификатор нужного отчета в ответе (идентификатор отчета можно найти в адресной строке браузера):
Выбранного сотрудника укажите в поле для получения отчета по расписанию.


http://joxi.ru/gmvy7gzS0Eqdvr
*Получите по REST API список отчетов методом '''/report/list''' и найдите идентификатор нужного отчета в ответе (идентификатор отчета можно найти в адресной строке браузера):


4. Методом /report/{id}/save/list  получаем список сохраненных версий данного отчета http://joxi.ru/zANPkVGtwov8Mm - находим идентификатор нужной нам версии
https://p.pfx.so/pf/ze/PGDwGM.png
5. Получаем данные отчета по идентификатору сохраненной версии методом /report/{id}/save/{saveId}/data  http://joxi.ru/KAg6WGdcOxE5N2


Если отчет большой то у версии будет несколько частей(чанков) chunks  при получении данных отчета необходимо будет передавать индекс чанка чтобы получить все части, например chunks = 2, передаем первым запросом chunk 2, вторым 1 и третьим 0, в итоге нам вернутся 3 порции данных отчета..
 
*Методом '''/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

  • Создайте повторяющийся отчет.
  • Создайте токен авторизации для сотрудника, которому планируете отправлять отчет. Сохраненные данные отчета доступны только сотрудникам, которых выберете для отправки. Для создания токена перейдите в Управление аккаунтомДоступ к APIREST APIСоздать новый токен:

DTaSBg.png


Выбранного сотрудника укажите в поле для получения отчета по расписанию.

  • Получите по REST API список отчетов методом /report/list и найдите идентификатор нужного отчета в ответе (идентификатор отчета можно найти в адресной строке браузера):

PGDwGM.png


  • Методом /report/{id}/save/list получите список сохраненных версий выбранного отчета:

Pa5goU.png


  • Получите данные отчёта по идентификатору новой версии методом /report/{id}/save/{saveId}/data:

1S5NYn.png


Важно

  • Сохраненные данные отчета доступны только сотрудникам, которых выберете для отправки.
  • Если отчет большой, то у версии будет несколько частей (чанков/chunks). При получении данных отчета необходимо передавать индекс чанка, чтобы получить все части. Сколько чанков содержит отчет видно в ответе метода /report/{id}/save/list.


Перейти