<?xml version="1.0" encoding="UTF-8"?><rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0" xmlns:cc="http://cyber.law.harvard.edu/rss/creativeCommonsRssModule.html">
    <channel>
        <title><![CDATA[Stories by Lucas Bicalho on Medium]]></title>
        <description><![CDATA[Stories by Lucas Bicalho on Medium]]></description>
        <link>https://medium.com/@lucassantosbicalho?source=rss-fd1f2c793ddd------2</link>
        <image>
            <url>https://cdn-images-1.medium.com/fit/c/150/150/1*Ssk9nwpqlb7os9tFKVkkUQ.jpeg</url>
            <title>Stories by Lucas Bicalho on Medium</title>
            <link>https://medium.com/@lucassantosbicalho?source=rss-fd1f2c793ddd------2</link>
        </image>
        <generator>Medium</generator>
        <lastBuildDate>Wed, 18 Nov 2026 17:50:46 GMT</lastBuildDate>
        <atom:link href="https://medium.com/@lucassantosbicalho/feed" rel="self" type="application/rss+xml"/>
        <webMaster><![CDATA[yourfriends@medium.com]]></webMaster>
        <atom:link href="http://medium.superfeedr.com/" rel="hub"/>
        <item>
            <title><![CDATA[Paginação de API com Progress OpenEdge (4GL)]]></title>
            <link>https://medium.com/totvsdevelopers/pagina%C3%A7%C3%A3o-de-api-com-progress-openedge-4gl-b8b01817c10?source=rss-fd1f2c793ddd------2</link>
            <guid isPermaLink="false">https://medium.com/p/b8b01817c10</guid>
            <category><![CDATA[api]]></category>
            <category><![CDATA[openedge]]></category>
            <category><![CDATA[totvs]]></category>
            <category><![CDATA[totvs-developers]]></category>
            <category><![CDATA[progress]]></category>
            <dc:creator><![CDATA[Lucas Bicalho]]></dc:creator>
            <pubDate>Thu, 31 Aug 2023 12:38:22 GMT</pubDate>
            <atom:updated>2023-08-31T12:38:22.888Z</atom:updated>
            <content:encoded><![CDATA[<figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*2vNS_PmDizF7vNMRuFd4Kw.png" /><figcaption>Figure: REST API — Author: Seobility — License: CC BY-SA 4.0</figcaption></figure><p>É mais do que conhecida a importância de enviar registros em lotes do servidor para o cliente por meio de APIs. Uma das vantagens é um menor tempo de espera por parte do cliente enquanto os dados são carregados, menor tráfego de dados desnecessários saindo do servidor, além de ser uma boa prática.</p><p>Neste artigo não entrarei em detalhes sobre configuração da IDE PDSOE, nem sobre criar um projeto <em>server</em>. Neste momento meu PDSOE já está configurado com uma conexão ao banco de dados sports2020, e um projeto OpenEdge com <em>server</em> e <em>REST transport</em> for PASOE, chamado ws.</p><p>Neste exemplo, faremos uma API para retornar registros da tabela item com um limite máximo de 200 registros por requisição, com opção de passar como parâmetros na URL do endpoint os parâmetros de quantidade e o id para o próximo lote de registros. Adicionaremos algumas validações e tratativa de erro.</p><p>Seções do artigo:</p><ol><li>Código (o arquivo .p)</li><li>Mapeando o <em>.p</em> como um endpoint</li><li>Testando o endpoint em uma instância local PASOE</li></ol><h3>1. Código (o arquivo .p)</h3><p>O código completo você pode <a href="https://github.com/lucassantosbicalho/ABL-WebService/blob/master/AppServer/Enterprise/Item/item.p">encontrar aqui</a>. Este programa se chama item.p e explico agora cada parte do código.</p><p>Começo definindo os objetos, como temp-table, datasource, dataset, e query:</p><pre>DEFINE TEMP-TABLE ttItem NO-UNDO<br>    FIELD ItemNum    LIKE Item.ItemNum <br>    FIELD ItemName   LIKE Item.ItemName <br>    FIELD Price      LIKE Item.Price <br>    INDEX ItemNum IS PRIMARY IS UNIQUE ItemNum.<br>    <br>DEFINE DATA-SOURCE srcItem FOR Item.<br>DEFINE DATASET dsItem FOR ttItem.<br>DEFINE QUERY qItem FOR ttItem.</pre><p>Em seguida, os parâmetros de <em>INPUT</em> e <em>OUTPUT</em>. Estes parâmetros serão usados na definição do endpoint no <em>REST Resource URI Editor</em>.</p><pre>DEFINE INPUT PARAM              iQty    AS INTEGER   NO-UNDO.<br>DEFINE INPUT-OUTPUT PARAM       pRowId  AS CHARACTER NO-UNDO.<br>DEFINE OUTPUT PARAM             cStatus AS CHARACTER NO-UNDO.<br>DEFINE OUTPUT PARAM DATASET FOR dsItem.</pre><p>O bloco principal, com toda a lógica e comentários em cada etapa:</p><pre>/* Limpa o dataset */<br>DATASET dsItem:EMPTY-DATASET ().<br><br>/* Validações iniciais */<br>IF iQty = 0 THEN RETURN.<br>IF iQty &gt; 200 THEN<br>DO:<br>    ASSIGN<br>        cStatus = &quot;Not alowed! Maximum of 200 records per request!&quot;.<br>    RETURN.<br>END.<br><br>ASSIGN<br>    cStatus = &quot;Unknown error!&quot;.<br><br>/* Vincula o datasource srcItem ao buffer ttItem */<br>BUFFER ttItem:ATTACH-DATA-SOURCE(DATA-SOURCE srcItem:HANDLE).<br><br>/* Configura o RESTART-ROWID usando o pRowId informado */<br>IF LENGTH(pRowId) &gt; 0 THEN<br>  DATA-SOURCE srcItem:RESTART-ROWID = TO-ROWID(pRowId).<br><br>/* Configura quantidade de registros por lote */<br>BUFFER ttItem:BATCH-SIZE = iQty.<br><br>/* Limpa a tabela antes da operação FILL (preencher) iniciar */<br>BUFFER ttItem:FILL-MODE = &quot;EMPTY&quot;.<br><br>/* Preenche dataset */<br>DATASET dsItem:FILL().<br><br>/* Obtém próximo NEXT-ROWID do DATA-SOURCE para retornar ao cliente */<br>pRowId = STRING(DATA-SOURCE srcItem:NEXT-ROWID).<br><br>/* Desvincula o datasource */<br>BUFFER ttItem:DETACH-DATA-SOURCE().<br><br>ASSIGN<br>    cStatus = &quot;Success!&quot;.</pre><p>Adicionando o <em>CATCH</em> usando <em>Progress.Lang.Error</em>, para capturar qualquer condição não esperada ocorrida durante a execução:</p><pre>CATCH err AS Progress.Lang.Error:<br>    DEFINE VARIABLE iMessage AS INTEGER NO-UNDO.<br>    <br>    DO WHILE iMessage &lt; err:NumMessages:<br>        ASSIGN <br>            cStatus = SUBSTITUTE (&quot;&amp;1~n&amp;2&quot;, cStatus, err:GetMessage(iMessage))<br>            iMessage = iMessage + 1.<br>    END.<br>    IF err:CallStack &lt;&gt; ? THEN DO:<br>        ASSIGN <br>            cStatus = SUBSTITUTE (&quot;&amp;1~n~nCall Stack:~n&amp;2&quot;, cStatus, err:CallStack).<br>    END.<br>END CATCH.</pre><p>Uma vez que o código está pronto, o próximo passo é mapear o programa (<em>.p</em>) como um endpoint no <em>REST Resource URI Editor</em>.</p><h3>2. Mapeando o .p como um endpoint</h3><p>No <em>REST Resource URI Editor</em> você pode adicionar um novo recurso (endpoint) e associar os programas aos verbos (GET, PUT, POST e DELETE).</p><p>Criei um novo endpoint (chamado item), e selecionei o arquivo item.p para ser vinculado ao verbo GET:</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/0*Y-g1Ndyc3JLAfO0Z" /><figcaption>Vinculando o programa com o verbo no REST Resource URI Editor</figcaption></figure><p>Então fiz a vinculação dos parâmetros de entrada (input) como <em>Query String Parameters</em>, os parâmetros que serão informados na URL do endpoint:</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/917/0*2lsjbP9uy9PT_huD" /><figcaption>Vinculando parâmetros de entrada</figcaption></figure><p>Finalmente, vinculei os parâmetros de saída (output) ao <em>Response Body</em>:</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/893/0*Fl1WNF0Ax1xvYC82" /><figcaption>Vinculando parâmetros de saída</figcaption></figure><p>Como já tenho uma instância do PASOE rodando localmente, e o projeto já está publicado no OpenEdge Explorer, a próxima etapa é testar o endpoint.</p><h3>3. Testando o endpoint em uma instância local PASOE</h3><p>Para testar o limite de registros permitidos, faço a chamada ao <em>endpoint</em> passando 300 registros na requisição através do parâmetro iQty:</p><p><a href="http://localhost:8810/ws/rest/wsService/item?iQty=300:">http://localhost:8810/ws/rest/wsService/item?iQty=300</a></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/802/0*yXfGIMIWciMJIkSg" /></figure><p>A primeira validação executou com sucesso!</p><p>Agora, farei dois testes, informando a quantidade de registros = 3.</p><p>1º teste: chamar o <em>endpoint</em> sem passar o parâmetro pRowId, o que deve resultar nos três primeiros registros da tabela, usando http://localhost:8810/ws/rest/wsService/item?iQty=3</p><p>2º teste: passar o pRowId, obtido da requisição anterior, como parâmetro para a próxima requisição (http://localhost:8810/ws/rest/wsService/item?iQty=3&amp;pRowId=0x0000000000005c04)</p><p>Veja os resultados abaixo:</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/0*Q2GvWCArffnI9Muw" /><figcaption>Testando com limite de registros aceitável e passando pRowId para obter a próxima paginação</figcaption></figure><p>Veja que na requisição da esquerda foram retornados três registros (ItemNum 1, 2 e 3) e o id do próximo registro. Na requisição da direita, foi informado este id como parâmetro na URL, e o resultado retornado foram os três próximos registros (ItemNum 4, 5 e 6) e o id do próximo registro. Se não houver um próximo registro, o campo pRowId no <em>JSON </em>virá vazio.</p><p>Aqui está um exemplo simples de escopo específico. <strong>Esta não é a única forma de realizar paginação em API usando Progress OpenEdge, e com certeza existem várias outras.</strong></p><p>Conhece outra maneira? Compartilhe, vamos aprender juntos!</p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=b8b01817c10" width="1" height="1" alt=""><hr><p><a href="https://medium.com/totvsdevelopers/pagina%C3%A7%C3%A3o-de-api-com-progress-openedge-4gl-b8b01817c10">Paginação de API com Progress OpenEdge (4GL)</a> was originally published in <a href="https://medium.com/totvsdevelopers">TOTVS Developers</a> on Medium, where people are continuing the conversation by highlighting and responding to this story.</p>]]></content:encoded>
        </item>
    </channel>
</rss>