Índice
Índice |
---|
exclude | .*ndice |
---|
printable | false |
---|
|
Objetivo
A API de busca de objeto de negócio tem como objetivo viabilizar a leitura de um objeto de negócio que esta vinculado a um recurso do TReports através do ERP TOTVS.
Informações |
---|
|
A API pública de Busca de Objeto de Negócio está disponível em qualquer instalação do TReports a partir da versão 2.2 e suas operações estão documentadas via Swagger. |
API
A API de busca de objeto de negócio recebe em sua rota o tipo do recurso e seu identificador e retorna o objeto de negócio que está vinculado ao recurso solicitado.
Os tipos de recursos suportados pela API são:
- Relatórios;
- Tabelas dinâmicas;
- Visões de dados;
Para utilizar o endpoint é necessário informar o tipo do recurso(resourceType) e o id do recurso.
O valores possíveis para resourceType são:
- report: Relatórios
- pivot-table: Tabelas dinâmicas
- data-grid: Visões de dados
O formato de retorno da API para o objeto de negócio do recurso é:
- {connectorId}: Identificador do conector ao qual um objeto de negócio é vinculado
- {name}: Identificador do objeto de negócio vinculado ao recurso informado
Detalhes da implementação são encontrados no endpoint abaixo:
Image Modified
Erros na busca de objeto negócio
A busca não será realizada caso ocorra um erro durante a chamada à API. Nesses casos a API irá retornar um código e uma mensagem com mais detalhes do erro. As possíveis causas de erro e os respectivos códigos de erro retornado são:
Erro | Código |
---|
Tipo de recurso inexistente | resources.presentation.rest-api.business-object-controller.resource-type-not-available |
Recurso não encontrado | resources.application.resource-not-found |
O formato de retorno da API em caso de erro é:
- {code}: Código de erro
- {message}: Mensagem de erro
- {detailedMessage}: Mensagem detalhada de erro
- {helpUrl}: Url para ajuda sobre o erro (caso disponível)
- {details}: Lista contendo os erros encontrados para cada arquivo importado.
Exemplo de uso da API
Abaixo será exemplificado um caso em que o ERP solicita a busca do objeto de negócio vinculado a um relatório:
Bloco de código |
---|
theme | RDark |
---|
title | Requisição à API |
---|
|
GET /api/resources/v1/report/b740a858-219e-465b-acd9-7496d653e152/business-object |
Bloco de código |
---|
language | js |
---|
theme | RDark |
---|
title | Resposta da API |
---|
|
{
"connectorId": "dcc52856-63e6-4836-bed2-b725d83fc20b",
"name": "InstalacoesAtivas"
} |