Exibir origem

Descrição

API genérica para a listagem de dados de uma Consulta Padrão (SXB) do TOTVS Backoffice 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.

É 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.

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	X

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).

Campo	Permitido?
A1_COD	Sim
SUBSTRING(A1_COD, 1, 3)	Não - Campo não será retornado pelo serviço
SA1->(A1_COD + A1_LOJA)	Não - Campo não será retornado pelo serviço

{
 	"descriptor": {
        "a1_cod": "Codigo",
        "a1_loja": "Loja",
        "a1_nome": "Nome"
    }
}

Filtros

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.

Filtro utilizando o padrão oData

http://localhost:8080/rest/api/framework/v1/genericLookupService/smartui/:alias?pageSize=3&page=1&$filter=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.

{
	"keyProperty": "a1_cod"
}