Webapi

WebAPI – Relatórios

90 views 2 Janeiro, 2020 3 Fevereiro, 2020 Valuekeep 0

Este serviço permite a obtenção de relatórios por um utilizador no Valuekeep.

De seguida é apresentada uma análise dos métodos disponibilizados pelo serviço.

Obter relatório

Este método permite obter a impressão de um relatório em PDF, usando os seguintes parâmetros:

  • module: módulo da entidade do relatório;
  • entity: entidade do relatório;
  • reportKey: código do relatório;
  • fileName: nome do ficheiro a exportar (sem extensão);
  • paramKey e paramValue: pares chave/valor que correspondem aos parâmetros a passar na impressão do relatório.

Os parâmetros module, entity e reportKey são obrigatórios.

GET /api/mytenant/myorganization/reporting/reports/getreport?module=MyModule&entity=MyEntity&reportKey=MyReport

GET /api/mytenant/myorganization/reporting/reports/getreport?module=MyModule&entity=MyEntity&reportKey=MyReport&fileName=RepXX-123

GET /api/mytenant/myorganization/reporting/reports/getreport?module=MyModule&entity=MyEntity&reportKey=MyReport&fileName=RepXX-123&paramKey=FirstParam&paramValue=FirstValue&paramKey=SecondParam&paramValue=SecondValue

Exemplo:

Obter a impressão do relatório operacional da OT (todas as OTs).

GET /api/mytenant/myorganization/reporting/reports/getreport?module=MaintenanceManagementCore&entity=WorkOrders&reportKey=WOWORKREPORT

Foi útil?