Hi Michael,

Thank you for the feedback.

That makes sense. I agree that it would be better to first define the
broader REST API paging requirements and approach, and then derive the
implementation from that.

I have created a sub-task under OFBIZ-11328 for this discussion:

OFBIZ-13457 <https://issues.apache.org/jira/browse/OFBIZ-13457> - Define
generic REST API paging requirements and design

The goal there is to capture the generic paging model and requirements,
including topics such as:


   - paging metadata in responses
   - previous/next page links
   - page position and page size information
   - navigation-related metadata
   - compatibility with existing OFBiz paging conventions such as
   VIEW_INDEX and VIEW_SIZE


The helper methods I proposed can then be revisited in that broader context
as possible reusable implementation pieces, if they align with the agreed
design.

Thanks again for the guidance.

Regards
Divesh Dutta
--
www.hotwaxsystems.com


On Tue, Jul 7, 2026 at 3:55 PM Michael Brohl <[email protected]>
wrote:
>
> Hi Divesh,
>
> thanks for this initiative. I see the need for paging support also.
>
> At first glance I think that we should dig a little big deeper into
> concepts for REST-API paging and derive the implementation from that.
>
> There are some more topics to think of, like
>
> * returning informations about paging position and size
>
> * previous and next page links
>
> * number of previous and next pages
>
> * ...
>
> Would you mind creating an issue as subtask to
> https://issues.apache.org/jira/browse/OFBIZ-11328 ?
>
> We can add requirements and references there and work out the solution
> to fit all requirements.
>
> Thanks and regards,
>
> Michael Brohl
>
> ecomify GmbH - www.ecomify.de
>
>
> Am 07.07.26 um 08:16 schrieb Divesh Dutta:
> > Here is the exact code that I committed in my feature branch, which was
> > created from a fork of the OFBiz trunk.
> >
> >
https://github.com/diveshdut/ofbiz-framework/commit/4cbcd3c41be0f4e1bb6b8ffde1055dc5f67ea2c8
> >
> > If this looks generally acceptable, I will create the Jira ticket and
pull
> > request for OFBiz trunk.
> >
> > Thanks
> > --
> > Divesh Dutta
> > www.hotwaxsystems.com
> >
> > On Tue, Jul 7, 2026 at 11:32 AM Divesh Dutta <
[email protected]>
> > wrote:
> >
> >> Hi all,
> >>
> >> While working on PWA apps for Manufacturing, I encountered the same
REST
> >> pagination logic in a few places. Since the need itself is generic and
not
> >> really manufacturing-specific, I thought it might make sense to move
that
> >> logic into RestApiUtil as reusable helpers.
> >>
> >> I’m thinking about adding these four methods to:
> >>
> >>
framework/restapi/src/main/java/org/apache/ofbiz/ws/rs/util/RestApiUtil.java:
> >>
> >> Here are the 4 methods:
> >>
> >> 1) getPagingParameters(Map<String, ?> parameters):
> >>
> >>      This would normalize paging inputs into a standard pageIndex and
> >> pageSize, including defaults and support for both pageIndex/pageSize
and
> >> VIEW_INDEX/VIEW_SIZE.
> >>
> >>
> >> 2) getPartialList(EntityQuery query, int pageIndex, int pageSize):
> >>
> >>      This would wrap the usual EntityListIterator.getPartialList(...)
usage
> >> so services avoid repeating paging calculations and iterator handling.
> >>
> >>
> >>
> >> 3) getPagedResult(int pageIndex, int pageSize, long totalCount, String
> >> listName, List<?> rows) :
> >>
> >>
> >>      This would create a standard paged REST response map with metadata
> >> like page index, page size, total count, and the actual result list.
> >>
> >> 4) getParameterValueIgnoreCase(Map<String, ?> parameters, String...
names)
> >> :
> >>
> >>      This would help look up request parameters by accepted aliases
> >> case-insensitively.
> >>
> >>
> >>
> >> The main goal is to avoid repeating the same small pieces of logic in
REST
> >> services and to keep pagination handling more consistent across
endpoints.
> >>
> >> Although I first needed this while building Manufacturing PWAs, the
> >> methods themselves are generic, so I think RestApiUtil is the right
place
> >> for them.
> >>
> >> If this sounds reasonable, I can prepare a Jira ticket and contribute
the
> >> code.
> >>
> >> Thanks
> >> --
> >> Divesh Dutta
> >> www.hotwaxsystems.com
> >>
> >>

Reply via email to