IBM Support

getPage API support for GENERIC strategy

Question & Answer


Question

Why does getPage API only supports "GENERIC" strategy, if XML path is provided in IBM Sterling Order Management?

Cause

You do not want to load all records upfront

Answer

getPage is a wrapper over the underlying API. It can only act upon the API output template structure received from the underlying API.
Under GENERIC strategy, the results are fetched in one go and are cached. XMLPath attribute is only supported for GENERIC strategy. After fetching the results, getPage goes over the API output and massages it such that the provided XML path is returned in output.

If you do not want to load all records upfront, then you should not use NEXTPAGE strategy. However, this does not support XMLPath.
You can apply the necessary XML Path manipulation themselves in the custom UI, before showing the results. You can go over the results from getPage API and remove the "unwanted" elements from the output to suit their needs. Note that, t

his is what getPage will have to do if it has to allow XMLPath for NEXTPAGE.

[{"Product":{"code":"SS6PEW","label":"Sterling Order Management"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Component":"--","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF016","label":"Linux"},{"code":"PF033","label":"Windows"}],"Version":"9.5;9.4;9.3","Edition":"","Line of Business":{"code":"LOB59","label":"Sustainability Software"}}]

Document Information

Modified date:
16 June 2018

UID

swg21991759