Histórico da Página

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.

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

{
 	"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.

Exemplo de uso - 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"
}

Smart view

Descrição

blah blah blah

Parâmetros

Exemplo de uso 

Smart UI

Descrição

Obtem os dados de uma consulta padrão utilizando o padrão estabelecido pela biblioteca Smart UI, listando os recursos da tabela e os metadados da consulta padrão. 

Parâmetros

Exemplo de uso utilizando filtro e paginação

http://localhost:8080/rest/api/framework/v1/genericLookupService/smartui/SA1?pageSize=3&page=1&$filter=contains(a1_nome, 'CLIENTE') and a1_loja eq '01'

{
    "items": [
		{
            "a1_cod": "000001",
            "a1_loja": "01",
            "a1_nome": "CLIENTE 01"
        }, {
            "a1_cod": "000002",
            "a1_loja": "01",
            "a1_nome": "CLIENTE 02"
        }, {
            "a1_cod": "000003",
            "a1_loja": "01",
            "a1_nome": "CLIENTE 03"
        }
    ],
    "hasNext": true,
    "remainingRecords": 20,
    "keyProperty": "a1_cod",
    "descriptor": {
        "a1_cod": "Codigo",
        "a1_loja": "Loja",
        "a1_nome": "Nome"
    }
}