Frameworksp

Páginas filhas
  • GenericList

Descrição:

Retorna uma listagem do alias informado.

Essa API foi criada com base na classe FWAdapterBaseV2, logo ela permite filtros, seleção de campos, paginação e ordenação.

Utilização da API

É necessário ligar a segurança do socket do rest para a utilização dessa api (chave SECURITY=1)

Parâmetros

NomeTipoDescriçãoObrigatórioValor padrão
AliasStringIndica o alias da tabela que terá seus dados listadosX
FilialFilterBooleanIndica se deve ser feito o filtro da filial ([ALIAS]_FILIAL) - Opcional, tendo seu valor como verdadeiro por padrão.
true
DeletedFilterBooleanIndica se deve ser feito o filtro de campos deletados de forma lógica (D_E_L_E_T_)
true
Exemplos de uso
api/framework/v1/genericList?alias=sed
api/framework/v1/genericList?alias=sed&filialFilter=true&deletedFilter=true&page=1&fields=ed_codigo,ed_descric&pagesize=15
O JSON retornado tem como chave o nome do campo na tabela, evitando assim problemas com localização.
Essa API efetua validações de privilégios, nível de campo e dados protegidos.

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ível de campos

Assim como nos dados protegidos, caso o usuário não tenha acesso a um campo, ele não será retornado, sendo listado na propriedade nivelFields do JSON de retorno.

Comportamento

Devido ao nome de algumas tabelas do Protheus terem três letras e serem palavras reservadas do SQL, algumas tabelas recebem o sufixo PFW para que a query funcione corretamente:

  • ADD
  • ALL
  • AND
  • ANY
  • ASC
  • AVG
  • DEC
  • END
  • FOR
  • INT
  • KEY
  • NOT
  • ROW
  • SET
  • SUM

Isso afeta apenas o alias (apelido) da tabela na query, exemplo: SELECT * FROM SETT10 SETPFW WHERE SETPFW.D_E_L_E_T_ = ' '

Essa mudança de comportamento está presente na lib 20241125 ou superior.

Exemplo de retorno - SE5
{
	"items": [
		{
			"e5_tipo": "NF",
			"e5_vlmoed2": 4692.5,
			"e5_motbx": "NOR",
			"e5_tipodoc": "VL",
			"e5_dtdispo": "2015-3-3",
			"e5_numero": "000812",
			"e5_parcela": "",
			"e5_loja": "01",
			"e5_filorig": "M SP 01",
			"e5_naturez": "FIS0000031",
			"e5_filial": "M SP 01",
			"e5_histor": "Valor recebido s/ Titulo",
			"e5_valor": 4692.5
		}
	],
	"remainingRecords": 474,
	"protectedDataFields": [
		"E5_BANCO",
		"E5_BENEF"
	],
	"nivelFields": [
		"E5_MSFIL"
	],
	"hasNext": true
}