kz.arta.synergy.api.rest.report

Class ReportService

java.lang.Object

kz.arta.synergy.api.rest.report.ReportService

public class ReportService
extends java.lang.Object

Класс отвечает за API взаимодействия с модулем отчетов. User: MGetmanov Date: 05.09.14 Time: 11:32

Constructor Summary

Constructors

Constructor and Description
ReportService()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getReport(java.lang.String fileName, java.lang.String reportID, java.lang.String parentIdentifier, java.lang.Boolean inline, java.lang.String locale) Метод позволяет получить результат выполнения отчета для пользователя.
java.lang.String	getReportListForUser(java.lang.String locale) Метод позволяет получить информацию о доступных текущему пользователю отчетов.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReportService

public ReportService()

Method Detail

getReportListForUser

public java.lang.String getReportListForUser(java.lang.String locale)

Метод позволяет получить информацию о доступных текущему пользователю отчетов. Данные передаются в формате JSON в кодировке utf-8. JSON имеет поля: reportID - идентификатор отчета nameen - название отчета для англоязычной локали nameru - название отчета для русскоязычной локали namekz - название отчета для казахскоязычной локали defaultName - имя файла по умолчанию fileName - имя файла objectType - идентификатор objectType отчета. Object Type - задается битовой маской

Объект конфигуратора - 0

Тип объекта цель - 2

Тип объекта поручение - 4

Тип объекта мероприятие (план) - 64

Тип объекта Задача - 8

Тип объекта показатель - 16

Пользователь - 32

План - 256

Портфель проектов - 128

Документ в журнале документов - 1024

Процесс - 512

Департамент - 2048

Должность - 4096

Маршрут - 8192

Карта - 16384

Файл - 32768

Реестр - 65536

Карточка документа - 131072

Группа - 262144

loadType - идентификатор типа загрузки отчета

1 - загрузить файл, 2 - сохранить в хранилище

Так же предаются параметры для каждого отчета. Они предаются в поле params, являющимся массивом JSON объектов Объект с описанием параметров содержит поля: code - Код параметра label - Подпись параметра value - Значение параметра по умолчанию type - Java класс, определяющий тип данных принимаемым в качетсве объекта параметра isOptional - является ли данный параметр опциональным

Для обращения к API методу необходимо обратиться по URL [SYNERGY_HOST]/Synergy/rest/api/report/list

Parameters:

locale - - не обязательный параметр указывающий необходимую локаль

Returns:

- JSON с результатами запроса

getReport

public java.lang.String getReport(java.lang.String fileName,
                         java.lang.String reportID,
                         java.lang.String parentIdentifier,
                         java.lang.Boolean inline,
                         java.lang.String locale)

Метод позволяет получить результат выполнения отчета для пользователя. Данные передаются в формате JSON в кодировке utf-8 или байтовым потоком - в зависимости от настроек отчета. При передаче параметров необходимо учитывать, что идентификаторы параметров регистрозависимые JSON имеет поля: reportDate - Дата создания отчета в формате GWT identifier - идентификатор файла отчета в хранилище path - путь отчету в хранилище parentIdentifier - идентификатор родительской директории В случае если отчет требует передачи параметров они должны быть переданы в url параметрах. Например если отчет требует передачи userID то в строку запроса необходимо добавить &userID=[USER_ID]. Для параметров users_names, user_names, department_name, departments_name, action_name, actions_name нужно передавать соответствующие идентификаторы. В случае перечисления идентификаторы разделять запятыми. Например, &user_names=userID1, userID2 Обязательные параметры для отчета обязательно должны присутствовать в строке запроса. Для обращения к API методу необходимо обратиться по URL [SYNERGY_HOST]/Synergy/rest/api/report/do

Parameters:

fileName - - требуемое имя файла. Если имя файла не было передано то будет использовано имя файла по умолчанию.

reportID - - идентификатор отчета

parentIdentifier - - идентификатор папки для сохранения отчета

inline - - тип передачи (true - inline/false - attachment)

locale - - требуемая локаль

Returns:

- результат выполнения запроса