Перейти к основному содержимому

Сервис генерации отчётов Платформы

Версия 5.10.1​

Сервис генерации отчётов Платформы

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

Тип запросаНазваниеОписание
post[/services/reporting_module/api/tasks/state](менеджер заданий.reporting-module#8d6047fd81a7903dc4841c63fd7bcae6)Метод выборки статуса выполнения задания
post[/services/reporting_module/api/tasks/result](менеджер заданий.reporting-module#7be9fa90c79abed675da9a4566588b93)Метод выборки результата выполнения задания
post[/services/reporting_module/api/tasks/remove](менеджер заданий.reporting-module#ed46ed0086b87550e342707d59651793)Метод удаление задания
post[/services/reporting_module/api/tasks/add](менеджер заданий.reporting-module#e14200e82009fa106386b95810c9ddb2)Метод постановки задания на обработку

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

Тип запросаНазваниеОписание
post[/services/reporting_module/api/tasks/report/export/page/by-user-id](параметры заданий.reporting-module#1f0d923affbe35696e7e6902b2bd8d0f)Метод постраничной выборки записей представления параметров выполнения заданий построения отчётов по идентификатору пользователя
post[/services/reporting_module/api/tasks/page/by-user-id](параметры заданий.reporting-module#f4f4abcbbc3b4cfe141ee7ac84cba6cf)Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданному идентификатору пользователя, отличного от значения NULL
post[/services/reporting_module/api/tasks/page/by-state](параметры заданий.reporting-module#4656a10a2b94311f29c76af1a079323a)Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданному статусу
post[/services/reporting_module/api/tasks/page/by-start-date](параметры заданий.reporting-module#3bf18e0b432a5365cd2a582aa09b2cfb)Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданной дате начала обработки задания, отличной от значения NULL
post[/services/reporting_module/api/tasks/page/by-send-notification](параметры заданий.reporting-module#47bffe2c49f89ecdc835e4706d1a48af)Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданному признаку необходимости отправки нотификации пользователю о завершении выполнения задания
post[/services/reporting_module/api/tasks/page/by-send-notification-and-user-id](параметры заданий.reporting-module#4e0c1500156218bd6f830fb8321ac02c)Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданному признаку необходимости отправки нотификации пользователю о завершении выполнения задания и заданному идентификатору пользователя, отличного от значения NULL
post[/services/reporting_module/api/tasks/page/by-send-notification-and-null-user-id](параметры заданий.reporting-module#1f8a7b08ca054ce67274c62b9194b641)Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданному признаку необходимости отправки нотификации пользователю о завершении выполнения задания и идентификатору пользователя, значение которого равно NULL
post[/services/reporting_module/api/tasks/page/by-null-user-id](параметры заданий.reporting-module#d17328494d3d8302e0946a6992e4779b)Метод постраничной выборки записей таблицы хранения параметров выполнения задания по идентификатору пользователя, значение которого равно NULL
post[/services/reporting_module/api/tasks/page/by-null-start-date](параметры заданий.reporting-module#62ce364eda952d7da4242b67050ab4f3)Метод постраничной выборки записей таблицы хранения параметров выполнения задания по дате начала обработки задания, значение которой равно NULL
post[/services/reporting_module/api/tasks/page/by-null-completion-date](параметры заданий.reporting-module#4f9e1a898d5a7c7a2add23456d8dc8c2)Метод постраничной выборки записей таблицы хранения параметров выполнения задания по дате завершения обработки задания, значение которой равно NULL
post[/services/reporting_module/api/tasks/page/by-kind](параметры заданий.reporting-module#4e40ac0d9b7ecc9fff491b025cd45fc9)Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданному типу
post[/services/reporting_module/api/tasks/page/by-completion-date](параметры заданий.reporting-module#b12683621597783f81d993ca1c8b94e6)Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданной дате завершения обработки задания, отличной от значения NULL
post[/services/reporting_module/api/tasks/page/by-assignment-date](параметры заданий.reporting-module#f1d4d0d39267705a52e2098f2b7e6fae)Метод постраничной выборки записей таблицы хранения параметров выполнения задания по заданной дате поступления задания
post[/services/reporting_module/api/tasks/by-task-id](параметры заданий.reporting-module#ba37f7b5eb397919d25ac7e22cd0ae93)Метод выборки записи таблицы хранения параметров выполнения задания по заданному идентификатору задания
post[/services/reporting_module/api/tasks/by-id](параметры заданий.reporting-module#1d029cc7e1745694882cbda65471bcf0)Метод выборки записи таблицы хранения параметров выполнения задания по заданному идентификатору

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

Тип запросаНазваниеОписание
post[/services/reporting_module/api/reports/templates/remove](шаблоны отчётов.reporting-module#6793ae0d42dff3bed5a6c65d7ee39c1b)Метод удаления шаблона отчётов.
post[/services/reporting_module/api/reports/templates/get/page](шаблоны отчётов.reporting-module#fd6c7fb99577b1d20c523ae9ae7064c2)Метод постраничной выборки описаний шаблонов отчётов
post[/services/reporting_module/api/reports/templates/get/by-namespace-alias](шаблоны отчётов.reporting-module#782335fea004ae863bdc1b1eaec7be14)Метод выборки описания шаблона отчётов
post[/services/reporting_module/api/reports/templates/download/template](шаблоны отчётов.reporting-module#653390d28db536b5b60745510438b778)Метод выгрузки файла шаблона библиотеки Jasper Reports.
post[/services/reporting_module/api/reports/templates/download/settings](шаблоны отчётов.reporting-module#94f6b8633a865fd710e155135c97c493)Метод выгрузки файла настроек шаблона отчётов.
post[/services/reporting_module/api/reports/templates/download/settings-as-text](шаблоны отчётов.reporting-module#cbf15571dae4403f65e78d7b1d12c858)Метод выгрузки файла настроек шаблона отчётов в виде текста.
post[/services/reporting_module/api/reports/templates/add](шаблоны отчётов.reporting-module#d89af6bd6de27ef28eec59a089872bc9)Метод добавления/замены шаблона отчётов.
post[/services/reporting_module/api/reports/templates/add/by-zip](шаблоны отчётов.reporting-module#e10e3df9dc93ced3b09e48bc5ca5111a)Метод добавления шаблонов отчётов посредством архива в формате ZIP

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

Тип запросаНазваниеОписание
post[/services/reporting_module/api/reports/get/files-download-url](экспорт отчётов.reporting-module#8d57293f4446bcd3324c9a8596ee2cf0)Метод формирования URL выгрузки заданных файлов из PLM ИС Платформы
post[/services/reporting_module/api/reports/export](экспорт отчётов.reporting-module#452289ff5bb8694faf8b169503f505a0)Метод синхронного формирования отчёта
post[/services/reporting_module/api/reports/export/async](экспорт отчётов.reporting-module#fb8c7306b986625e8c2541b3b0c6c3b6)Метод асинхронного формирования отчёта