TREPORTS

Atalhos

Árvore de páginas

Índice

       

Objetivo

       O objetivo da API de Exportação de Recursos do TReports é promover uma forma de exportar os recursos existentes no TReports através ERP TOTVS. Com isso, o ERP TOTVS pode posteriormente injetar no TReports um conjunto de recursos padrões, como por exemplo relatórios administrativos e financeiros.

Informações

A API pública de Importação está disponível em qualquer instalação do TReports a partir da versão X.X e suas operações estão documentadas via Swagger.

API

A Exportação é uma API que permite a saída permanente ou temporária de um recurso do sistema e pode ser utilizada para diversos casos, como por exemplo: Backup de versionamento do recurso, salvar templates para serem depois utilizados, fazer download para envio à terceiros em outro sistema, entre outros. Essa API permite que apenas um recurso seja exportadod por vez.

O arquivo final da Exportação sempre será um zip que contém um arquivo .treports do recurso exportado (caso o recurso exportado seja um relatório que possua sub relatórios, eles estarão contidos nesse mesmo arquivo).

Detalhes da implementação são encontrados no endpoint abaixo:

Atualmente a API suporta a exportação dos tipos de recurso abaixo:

  • Relatórios, sendo o resourceType = report;
  • Tabelas Dinâmicas, sendo o resourceType = pivot-table;
  • Visões de Dados, sendo o resourceType = data-grid;

O envio da API para que um recurso seja exportado é:

Exemplos do Endpoint para Exportação de um Recurso
Exportação de um Relatório:
/api/resources/v1/report/dbdf682d-24d8-40d9-b7e4-0d42fff7b52f/export

Exportação de uma Tabela Dinâmica:
api/resources/v1/pivot-table/43533096-dc68-4b7c-8cbd-71b4a4f43f49/export

Exportação de uma Visão de Dados:
api/resources/v1/data-grid/c18852c3-f508-4483-b00e-e336dc014e62/export
  • Sem rótulos