API genérica para a listagem de dados de uma Consulta Padrão (SXB) do TOTVS linha Protheus.
Essa API foi criada com base na classe FWAdapterBaseV2, logo ela permite a utilização de filtros (oData) e a paginação de dados.
Utilização da API
É necessário ligar a segurança do socket do rest para a utilização dessa api (chave SECURITY=1)
Disponível a partir da lib 20231121.
Restrições
Tipos de consulta padrão suportadas
São suportadas pelo serviço somente consultas (SXB) do tipo Consulta padrão (DB).
Colunas
O serviço retorna somente os campos do primeiro indice da consulta padrão, ignorando todos os campos que contenham alguma função na definição da consulta.
Os detalhes dos campos retornados serão apresentados na propriedade descriptor contendo o nome do campo e descrição no dicionario de dados (SX3).
Dados protegidos
Caso o usuário que consuma a API não tenha acesso a algum campo, esses campos não são retornados e a propriedade protectedDataFields do JSON de retorno listará tais campos.
Não serão executados os filtros definidos no cadastro da Consulta Padrão, sendo executados somente os filtros recebidos no padrão oData da requisição.
Exemplo de uso - filtro utilizando o padrão oData
http://localhost:8080/rest/api/framework/v1/genericLookupService/smartview/:alias?pageSize=3&page=1&q=a1_cod eq '000001' and a1_loja eq '01'
Retorno da consulta
O serviço utiliza a propriedade keyProperty para informar qual campo será definido como o retorno da consulta, considerando somente um campo como retorno da Consulta padrão.
Exemplo de uso
Exemplo de keyProperty
{
"keyProperty": "a1_cod"
}
Smart view
Descrição
Obtem os dados de uma consulta padrão utilizando o padrão estabelecido para os Smart View, listando os recursos da tabela e os metadados da consulta padrão.
NextUrlPage
Indica a URL da proxima pagina dos recursos, podendo retornar nulo
Parâmetros
Nome
Tipo
Descrição
Obrigatório
Valor padrão
Alias
String
Indica o alias da consulta padrão que terá seus dados listados