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

Материал из Planfix
Перейти к: навигация, поиск
Нет описания правки
Нет описания правки
Строка 26: Строка 26:


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





Версия от 06:01, 7 сентября 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.


Перейти