Documentação de API - ENAPI205 - API para consultas de Estrutura

Objetivo

Esta API tem a funcionalidade de realizar consultas de estruturas, seja de forma item a item ou por uma faixa de itens, de forma completa ou sumarizada. Baseado nos parâmetros recebidos, a API fará a listagem da estrutura do item.

Funcionamento

Como parâmetros iniciais, são recebidos 3 tabelas temporárias (temp-tables).

tt-param – Tabela temporária de entrada (input)

tt-digita – Tabela temporária de entrada (input)

tt-estrutura – Tabela temporária de saída (output).

 A API pode ser executada de forma persistente ou de forma direta, conforme abaixo:

 De forma direta:

Run enp/enapi205.p (input table tt-param,

                                   Input table tt-digita,

                                   Output table tt-estrutura).

Persistente: 

Run enp/enapi205.p persistent set h-enapi205 (input table tt-param,

                                                                            input table tt-digita,

                                                                            Output table tt-estrutura).

Detalhe da execução dos modos, serão descritos abaixo.

Existem 3 formas para realizar a consulta de estruturas.

• Por Faixa (tt-param).

Este tipo de execução pode ser executado pela API de forma direta ou persistente.

Para execução persistente, basta executar o método pi-principal.

Run pi-principal in h-enapi205.

Obs.: Somente serão pesquisados os itens desta faixa se não houver nenhum registro na tabela temporária tt-digita.

• Por Itens selecionados (tt-digita);

Esta forma também pode ser executada de forma direta ou persistente, semelhante a execução do modo por faixa.

Obs: Somente serão pesquisados, quando houver registro na tt-digita. Com esta parametrização, alguns filtros não são realizados.

• Pesquisa por item :

Este método somente pode ser executado de forma persistente e não é necessário a execução do método pi-principal.

Deve-se executar conforme abaixo:

RUN setTTParam IN h-enapi205 (INPUT TABLE tt-param).

RUN gera-tt-estrutura IN h-enapi205 (INPUT v-row-id-item,

                                                              INPUT c-cod-refer,

                                                              INPUT da-data-corte).

RUN getTTEstrutura IN h-enapi205 (OUTPUT TABLE tt-estrutura).

Tabelas Temporárias

Nos atributos das tabelas temporárias de entrada e saída:

Parâmetros de Entrada

Parâmetros de Saída