Versões comparadas
Chave
- Esta linha foi adicionada.
- Esta linha foi removida.
- A formatação mudou.
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.
Informações | ||
---|---|---|
| ||
É necessário ligar a segurança do socket do rest para a utilização dessa api (chave SECURITY=1) |
Nota |
---|
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).
Painel | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||
|
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.
Exemplo de uso - filtro utilizando o padrão oData
Bloco de código |
---|
http://localhost:8080/rest/api/framework/v1/genericLookupService/smartuismartview/:alias?pageSize=3&page=1&$filterq=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.
Painel | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
|
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.
Informações | ||
---|---|---|
| ||
Indica a URL da proxima pagina dos recursos. |
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 | |
Page | Numeric | Número da pagina a ser retornada | 1 | |
PageSize | Numeric | Quantidade de registros por pagina | 200 | |
q | String | Filtro padrão oData |
Exemplo de uso
Bloco de código |
---|
http://localhost:8080/rest/api/framework/v1/genericLookupService/smartview/SA1?pageSize=2&page=1&q=a1_cod ge '000002' and a1_loja eq '01' and contains(a1_nome, 'LTDA') |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{
"data": [
{
"a1_cod": "000002",
"a1_loja": "01",
"a1_nome": "CLIENTE 02 LTDA"
},
{
"a1_cod": "000003",
"a1_loja": "01",
"a1_nome": "CLIENTE 03 LTDA"
}
],
"remainingRecords": 1,
"keyProperty": "a1_cod",
"descriptor": {
"a1_cod": "Codigo",
"a1_loja": "Loja",
"a1_nome": "Nome"
},
"nextPageUrl": "http://127.0.0.1:8282/rest/api/framework/v1/genericLookupService/smartview/SA1?pageSize=2&page=2&q=a1_cod ge '000002' and a1_loja eq '01' and contains(a1_nome, 'LTDA')"
} |