Índice
Índice |
---|
exclude | .*ndice |
---|
printable | false |
---|
|
Objetivo
O objetivo da API de Importação de Recursos do TReports é promover uma forma de importar recursos existentes através ERP TOTVS. Com isso, o ERP TOTVS pode 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 1.8.X (revisar na liberação) e suas operações estão documentadas via Swagger. |
API
A Importação é uma API que recebe um arquivo ZIP contendo os recursos exportados no TReports, realiza a importação na instância atual e retorna as informações dos recursos importados. É possível também realizar a importação de um arquivo único de um recurso (ver limitação abaixo).
Atualmente a API suporta a importação dos tipos de recurso abaixo:
- report: Relatórios;
- pivot-table: Para Tabelas Dinâmicas;
- data-grid: Para as Visões de Dados;
O formato de retorno da API para as informações dos recursos importados é:
- {fileName}: Nome do arquivo do recurso importado contido no arquivo ZIP enviado*
- {resourceType}: Tipo do recurso importado
- Valores possíveis
- "report": relatórios;
- pivot-table: tabelas Dinâmicas;
- data-grid: Para as Visões de Dados;
- {resourceId}: Id do recurso importado na instância atual do TReports
*Obs: Caso seja enviado um arquivo simples contendo um recurso, o campo fileName ira retornar como null.
Detalhes da implementação são encontrados no endpoint abaixo:
Image Modified
Exemplo de uso da API
A "alteração de compartilhamento do recurso" é uma API para completa alteração do compartilhamento do recurso, onde apenas os usuários com permissão de proprietário ou editor podem realizar a alteração.
A API suporta os tipos de recurso abaixo:
- report: Para Relatórios;
- report-v1: Para os Relatórios Legado;
- pivot-table: Para Tabelas Dinâmicas;
- data-grid: Para as Visões de Dados;
- dashboard-v1: para os Dashboards;
- folder: Para as Pastas;
O formato do conjunto de credenciais a serem aplicadas no recurso e que deverá ser informado no corpo da requisição é:
- {credential}: Credencial vinculada ao registro de compartilhamento
- {type}: Tipo da credencial
- Valores possíveis
- "User": Credencial de Usuário
- "Group": Credencial de Grupo
- "Role": Papeis do RBAC que o usuário possui
- {issuer}: Emissor da credencial
- {id}: Identificador da credencial
- {displayName}: Nome de exibição da credencial
- {permission}: Permissão de compartilhamento
Abaixo temos um exemplo de body da requisição com as credenciais do usuário que será o novo proprietário do recurso:
Bloco de código |
---|
|
{
"type": "User",
"issuer": "framework-bh.rac.dev.totvs.app/totvs.rac",
"id": "123",
"displayName": "John Doe"
} |