¿Cómo ejecutar listas en la WebAPI?

La mejor forma de obtener datos de la base de datos es utilizar las listas creadas en el ERP, que pueden ejecutarse mediante peticiones a la WebAPI.

Este proceso tiene varias ventajas, entre las que destacan la seguridad y la confidencialidad de la información, que está garantizada por el propio ERP, y el hecho de que se evita la inyección SQL en la base de datos.

Existen dos tipos de listas y ambas pueden ejecutarse con o sin parámetros:

• Listas estructuradas (asociadas a categorías del ERP);
• Listas adhoc (sql);

Listas estructuradas

Estas listas están directamente asociadas a las categorías del ERP (Artículos, Clientes, etc.). Para ejecutarlas, la ruta de petición debe indicar la categoría, seguida del identificador de la lista y de cualquier parámetros que considere necesario.

Ruta:

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

Exemplo:

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

Listas adhoc

Estas listas se basan en consultas SQL y no están vinculadas a categorías del ERP. Mediante listas adhoc puede utilizar instrucciones SQL para obtener cualquier información de la base de datos. También puede utilizar parámetros de entrada en las solicitudes de listas adhoc.

Ruta:

{{apiUrl}}Plataforma/Listas/CarregaLista/adhoc/?listId=[/av_/pre>
Exemplo:
{{apiUrl}}Plataforma/Listas/CarregaLista/adhoc/?listId=E74715FC-6CFB-4CFC-B810-5A50E120550D

Parámetros

Los parámetros de entrada de las listas (estructuradas o adhoc) deben indicarse en la ruta de solicitud, dentro de la variable listParameters y separados por una coma. El orden de los parámetros debe ser exactamente el mismo que el utilizado en la pantalla de recogida de parámetros del ERP cuando se ejecuta la lista.

Ruta:

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

Exemplo:

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

Listas predefinidas

También puede utilizar las listas predefinidas para cada categoría del ERP con el fin de obtener la información parametrizada para esa solicitud al invocar la categoría.

Ruta:

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

Exemplo:

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