Методы для взаимодействия с сервисом отчетов

Версия 6.1.4

Методы для взаимодействия с сервисом отчетов

Методы взаимодействия с шаблонами отчётов

Тип запроса	Название	Описание
post	/services/reporting_module/api/reports/templates/remove	Метод удаления шаблона отчётов.
post	/services/reporting_module/api/reports/templates/get/page	Метод постраничной выборки описаний шаблонов отчётов
post	/services/reporting_module/api/reports/templates/get/by-namespace-alias	Метод выборки описания шаблона отчётов
post	/services/reporting_module/api/reports/templates/download/template	Метод выгрузки файла шаблона библиотеки Jasper Reports.
post	/services/reporting_module/api/reports/templates/download/settings	Метод выгрузки файла настроек шаблона отчётов.
post	/services/reporting_module/api/reports/templates/download/settings-as-text	Метод выгрузки файла настроек шаблона отчётов в виде текста.
post	/services/reporting_module/api/reports/templates/add	Метод добавления/замены шаблона отчётов.
post	/services/reporting_module/api/reports/templates/add/by-zip	Метод добавления шаблонов отчётов посредством архива в формате ZIP

Методы взаимодействия с менеджером заданий

Тип запроса	Название	Описание
post	/services/reporting_module/api/tasks/state	Метод выборки статуса выполнения задания
post	/services/reporting_module/api/tasks/result	Метод выборки результата выполнения задания
post	/services/reporting_module/api/tasks/remove	Метод удаление задания
post	/services/reporting_module/api/tasks/add	Метод постановки задания на обработку

Методы формирования и последующей выгрузки отчетов в различных форматах

Тип запроса	Название	Описание
post	/services/reporting_module/api/reports/get/files-download-url	Метод формирования URL выгрузки заданных файлов из PLM ИС Платформы
post	/services/reporting_module/api/reports/export	Метод синхронного формирования отчёта
post	/services/reporting_module/api/reports/export/async	Метод асинхронного формирования отчёта

Методы выборки параметров заданий

Тип запроса	Название	Описание
post	/services/reporting_module/api/tasks/report/export/page/by-user-id	Метод постраничной выборки записей представления параметров выполнения заданий построения отчётов по идентификатору пользователя
post	/services/reporting_module/api/tasks/page/by-user-id	Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданному идентификатору пользователя, отличного от значения NULL
post	/services/reporting_module/api/tasks/page/by-state	Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданному статусу
post	/services/reporting_module/api/tasks/page/by-start-date	Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданной дате начала обработки задания, отличной от значения NULL
post	/services/reporting_module/api/tasks/page/by-send-notification	Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданному признаку необходимости отправки нотификации пользователю о завершении выполнения задания
post	/services/reporting_module/api/tasks/page/by-send-notification-and-user-id	Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданному признаку необходимости отправки нотификации пользователю о завершении выполнения задания и заданному идентификатору пользователя, отличного от значения NULL
post	/services/reporting_module/api/tasks/page/by-send-notification-and-null-user-id	Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданному признаку необходимости отправки нотификации пользователю о завершении выполнения задания и идентификатору пользователя, значение которого равно NULL
post	/services/reporting_module/api/tasks/page/by-null-user-id	Метод постраничной выборки записей таблицы хранения параметров выполнения задания по идентификатору пользователя, значение которого равно NULL
post	/services/reporting_module/api/tasks/page/by-null-start-date	Метод постраничной выборки записей таблицы хранения параметров выполнения задания по дате начала обработки задания, значение которой равно NULL
post	/services/reporting_module/api/tasks/page/by-null-completion-date	Метод постраничной выборки записей таблицы хранения параметров выполнения задания по дате завершения обработки задания, значение которой равно NULL
post	/services/reporting_module/api/tasks/page/by-kind	Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданному типу
post	/services/reporting_module/api/tasks/page/by-completion-date	Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданной дате завершения обработки задания, отличной от значения NULL
post	/services/reporting_module/api/tasks/page/by-assignment-date	Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданной дате поступления задания
post	/services/reporting_module/api/tasks/by-task-id	Метод выборки записи таблицы хранения параметров выполнения задания по заданному идентификатору задания
post	/services/reporting_module/api/tasks/by-id	Метод выборки записи таблицы хранения параметров выполнения задания по заданному идентификатору

Методы отладки скрипта шаблона отчёта

Тип запроса	Название	Описание
post	/services/reporting_module/api/debug/get/report-data	Метод выборки данных для формирования отчётов в формате JSON
post	/services/reporting_module/api/debug/get/report-data-v2	Метод выборки данных для формирования отчётов в формате JSON
post	/services/reporting_module/api/debug/get/report-data-as-file	Метод выборки данных для формирования отчётов в виде файла