Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Índice


       

Índice
exclude.*ndice
printablefalse

Objetivo


       O objetivo da API de Compartilhamento de Recursos do TReports é promover uma forma de consultar e manipular o compartilhamento dentro do ERP TOTVS. 

Informações
titleInformações

As APIs públicas de Compartilhamento estão disponíveis 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.

Busca de Compartilhamento


A "busca de compartilhamento" é uma API que retorna a credencial e permissão dos usuários com acesso ao recurso. Através dessa API é possível buscar apenas os recursos nos quais o usuário possui permissão de acesso, sejam elas de sua própria criação ou que tenham sido compartilhadas com o usuário de forma única ou através de pastas.

A API possui 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 de retorno da API para os registros de compartilhamento do recurso é:

  • {permission}: Permissão de compartilhamento
    • Valores possíveis
      • 0 ou "None": Nenhuma permissão
      • 1 ou "Viewer": Permissão de visualizador do recurso
      • 2 ou "Editor": Permissão de editor do recurso
      • 3 ou "Owner": Permissão de proprietário do recurso
  • {credential}: Credencial vinculada ao registro de compartilhamento
    • {type}: Tipo da credencial
      • Valores possíveis
        • 1 ou "User": Credencial de Usuário
        • 2 ou "Group": Credencial de Grupo
        • 3 ou "Role": Papeis do RBAC que o usuário possui
    • {issuer}: Emissor da credencial
    • {id}: Identificador da credencial
    • {displayName}: Nome de exibição da credencial

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


Abaixo temos um exemplo das credenciais e permissões dos usuários em um recurso retornadas pela API:

Bloco de código
themeRDark
titleResponse Body
[
    {
        "permission": "Viewer",
        "credential": {
            "type": "User",
            "issuer": "framework-bh.rac.dev.totvs.app/totvs.rac",
            "id": "12345",
            "displayName": "César Rodrigues"
        }
    },
    {
        "permission": "Editor",
        "credential": {
            "type": "User",
            "issuer": "framework-bh.rac.dev.totvs.app/totvs.rac",
            "id": "23456",
            "displayName": "John Doe"
        }
    }
]

Alterar Compartilhamento do Recurso


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 do recurso podem realizar a alteração

A API possui 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 que substituirão as antigas que deverá ser informado no corpo da requisição é:

  • {credential}: Credencial vinculada ao registro de compartilhamento
    • {type}: Tipo da credencial
      • Valores possíveis
        • 1 ou "User": Credencial de Usuário
        • 2 ou "Group": Credencial de Grupo
        • 3 ou "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
    • Valores possíveis
      • 0 ou "None": Nenhuma permissão
      • 1 ou "Viewer": Permissão de visualizador do recurso
      • 2 ou "Editor": Permissão de editor do recurso
      • 3 ou "Owner": Permissão de proprietário do recurso

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

Abaixo temos um exemplo de body da requisição com das credenciais e permissões dos usuários que terão o recurso compartilhado:

Bloco de código
themeRDark
titleBody
[
    {
        "permission": "Editor",
        "credential": {
            "type": "User",
            "issuer": "framework-bh.rac.dev.totvs.app/totvs.rac",
            "id": "1234",
            "displayName": "César Rodrigues"
        }
    },
    {
        "permission": "Viewer",
        "credential": {
            "type": "User",
            "issuer": "framework-bh.rac.dev.totvs.app/totvs.rac",
            "id": "4321",
            "displayName": "John Doe"
        }
    }
]

Busca de Proprietário


A "busca de proprietário" é uma API que retorna a credencial do usuário proprietário do recurso. Através dessa API é possível buscar apenas os recursos nos quais o usuário possui permissão de acesso, sejam elas de sua própria criação ou que tenham sido compartilhadas com o usuário de forma única ou através de pastas.

A API possui 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 de retorno da API para a credencial de segurança do proprietário do recurso é:

  • {type}: Tipo da credencial
    • Valores possíveis
      • 1 ou "User": Credencial de Usuário
      • 2 ou "Group": Credencial de Grupo
      • 3 ou "Role": Papeis do RBAC que o usuário possui
  • {issuer}: Emissor da credencial
  • {id}: Identificador da credencial
  • {displayName}: Nome de exibição da credencial

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


Abaixo temos um exemplo da credencial de usuário proprietário retornada pela API:

Bloco de código
themeRDark
titleResponse Body
{
    "type": "User",
    "issuer": "framework-bh.rac.dev.totvs.app/totvs.rac",
    "id": "123",
    "displayName": "Administrador do Tenant"
}

Alterar Proprietário do Recurso


A "alteração de proprietário do recurso" é uma API para alteração do proprietário do recurso, onde apenas o usuário proprietário atual do recurso pode realizar a alteração

A API possui 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 da credencial de segurança do Proprietário do recurso que deverá ser informado no corpo da requisição é:

  • {type}: Tipo da credencial
    • Valores possíveis
      • 1 ou "User": Credencial de Usuário
      • 2 ou "Group": Credencial de Grupo
      • 3 ou "Role": Papeis do RBAC que o usuário possui
  • {issuer}: Emissor da credencial
  • {id}: Identificador da credencial
  • {displayName}: Nome de exibição da credencial

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

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
themeRDark
titleBody
{
	"type": "User",
	"issuer": "framework-bh.rac.dev.totvs.app/totvs.rac",
	"id": "123",
	"displayName": "John Doe"
}
Informações
iconfalse
Informações
iconfalse

Produto: Framework

Informações
iconfalse

Processo: TReports 

Informações

Versão: 1.8.X

Informações
iconfalse
Informações
iconfalse

Status: Rascunho

Informações
iconfalse

Data:  

Informações
iconfalse

Autores
 Aline Cristina Braz de Oliveira 

Carlos Philippe de Farias Marques 

Cesar Henrique Silva Rodrigues_ 

Usuário desconhecido (fernando.souza)

Usuário desconhecido (samuel.frederico) 

Wemerson Marcelo Martins Guimarães 


Page Tree