Open APIs

 View Only

  • 1.  TMF 620 v4.1 - Question on support for hierarchy of products

    TM Forum Member
    Posted 4 days ago

    Hello, 

    Would like to know whether TMF 620 v4.1 supports hierarchy of products where a bundled product and its underlying hierarchy (one or more levels) can be retrieved in a Get call. 
    e.g. Product A is a bundle which includes Product B. Product B is also a bundle which includes Product C. 
    So when retrieving Product A, are we able to get the Product B as well as Product C?



    ------------------------------
    Siddhesh Pankar
    Salesforce
    ------------------------------


  • 2.  RE: TMF 620 v4.1 - Question on support for hierarchy of products

    TM Forum Member
    Posted 3 days ago
    Edited by Matthieu Hattab 2 days ago

    Hi,

    TMF620 does not return a full recursive hierarchy of bundled product offerings in a single GET call.

    A GET on /productOffering/{id} only returns one level of bundledProductOffering[]. TMF620 deliberately stops at one level.

    It does not provide any "depth" or recursive expansion mechanism. This is consistent with the catalogue design principles in IG1261 and the SID patterns:

    • Product Catalogue is declarative and expose intents.

    • Runtime expansion belongs to the Configurator or similar service or an orchestration layer, not to the catalogue.

    I can see 3 options:

    1. If you already use product configurator, TMF760 provides a runtime configuration tree for a bundle with a (full) recursive hierarchy, and it supports depth so you can choose how "deep" you want to go. However, it's a runtime tree, not a catalogue-designed bundle tree, meaning all catalogue configuration rules have been computed, it may not meet your requirement.

    2. Use a service that can orchestrate TMF620 and make multiple GET calls to build a recursive hierarchy of bundled product offerings. The output would be your chosen API schema.

    3. modify TMF620 OAS and add support for recursive hierarchy and depth.

    Good luck!



    ------------------------------
    Kind regards,

    Matthieu Hattab
    Digital Sales, Core Commerce Domain Architect
    Ex-Lyse Tele, Open to Work
    ------------------------------

    Original Message


  • 3.  RE: TMF 620 v4.1 - Question on support for hierarchy of products

    TM Forum Member
    Posted 3 days ago

    As per TMF 630 REST API Guidelines, all TMF APIs can support `depth` and `expand` query parameters. Using these you can support retrieval of child product offerings.



    ------------------------------
    Manu
    ------------------------------

    Original Message


  • 4.  RE: TMF 620 v4.1 - Question on support for hierarchy of products

    TM Forum Member
    Posted 3 days ago

    Hi,

    Thanks. It is true that TMF630 allows APIs to optionally support generic parameters like depth and expand, but the API schema must support it.

    TMF620 does not define any behaviour for recursive expansion of bundledProductOffering[], the OAS only models one containment layer. So even if you added ?depth=2in your request, the API would not know how to materialise deeper levels because bundledProductOffering[] is deliberately non-recursive.



    ------------------------------
    Kind regards,

    Matthieu Hattab
    Digital Sales, Core Commerce Domain Architect
    Ex-Lyse Tele, Open to Work
    ------------------------------

    Original Message