Como executar listas na WebAPI?

A melhor forma de obter dados da base de dados é utilizar as listas criadas no ERP, que podem ser executadas através de pedidos à WebAPI.

Este processo tem várias vantagens, das quais destacamos a segurança e confidencialidade da informação, que é garantida pelo próprio ERP e o facto de evitar a injeção de SQL na base de dados.

Há dois tipos tipos de listas e ambas podem ser executadas com ou sem parâmetros:

• Listas estruturadas (associadas às categorias do ERP);
• Listas adhoc (sql);

Listas estruturadas

Estas listas estão diretamente associadas às categorias do ERP (Artigos, Clientes, etc.). Para as executar, a rota do pedido deve indicar a categoria, seguida do identificador da lista e de quaisquer parâmetros que considere necessários.

Rota:

{{apiUrl}}Plataforma/Listas/CarregaLista/[Categoria]?listId=[Id]

Exemplo:

{{apiUrl}}Plataforma/Listas/CarregaLista/Artigo?listId=FE2E9AA6-5851-4F41-BF9B-1169AFEB7BE8

Listas adhoc

Estas listas são baseadas em queries SQL e não estão ligadas a categorias do ERP. Através de listas adhoc pode utilizar instruções SQL para obter qualquer informação da base de dados. Também é possível utilizar parâmetros de entrada em pedidos de listas adhoc.

Rota:

{{apiUrl}}Plataforma/Listas/CarregaLista/adhoc/?listId=[Id]

Exemplo:

{{apiUrl}}Plataforma/Listas/CarregaLista/adhoc/?listId=E74715FC-6CFB-4CFC-B810-5A50E120550D

Parâmetros

Os parâmetros de entrada das listas (estruturadas ou adhoc) devem ser indicados na rota do pedido, dentro da variável listParameters e separados por uma vírgula. A ordem dos parâmetros deverá ser exatamente a mesma que é usada no ecrã de recolha de parâmetros no ERP, quando a lista é executada.

Rota:

{{apiUrl}}Plataforma/Listas/CarregaLista/adhoc/?listId=[Id]&listParameters=[Param1],[Param2]

Exemplo:

{{apiUrl}}Plataforma/Listas/CarregaLista/adhoc/?listId=0AEA772A-FAA1-11E2-8941-000C29012C68&listParameters=2019,SOFRIO

Listas predefinidas

Também pode utilizar as listas predefinidas de cada categoria do ERP para obter as informações parametrizadas desse pedido ao invocar a categoria.

Rota:

{{apiUrl}}Plataforma/Listas/CarregaLista/[Categoria]

Exemplo:

{{apiUrl}}Plataforma/Listas/CarregaLista/Artigo