Open APIs

 View Only
  • 1.  TMF Open API - Filtering of first level attributes

    TM Forum Member
    Posted Mar 20, 2024 10:26

    Hi all,

    We could observe that attribute selection is enabled for all first level attributes for GET ProductOffering and GET API calls any other other resources as well.

    As per our observation, Similar attribute selection is possible with other resources in TMF 620 and with every other TMF Open API too.

    As per our understanding, first level attributes in case of ProductOffering resource refers to the attributes present on ProductOffering resource depicted in below figure -

    And, if we have a use case like find all ProductOfferings having ProductOfferingCharacteristic with name = Maximum Upstream Bandwidth, is there a TMF recommended way to support this via filtering/attribute selection criterion?

    Note: The question is asked in scope of ProductOffering but there could be any such use cases needed in TMF 620 or TMF 622 or any other TMF Open API as well



    ------------------------------
    Varun Pandhi
    Infosys
    ------------------------------


  • 2.  RE: TMF Open API - Filtering of first level attributes

    TM Forum Member
    Posted Mar 21, 2024 02:23

    Hi Varun,

    The generic approach to filtering/attribute selection using JSONPath is decribed in "TMF630 REST API Design Guidelines Part 6"

    Regards



    ------------------------------
    Koen Peeters
    OryxGateway FZ LLC
    ------------------------------



  • 3.  RE: TMF Open API - Filtering of first level attributes

    TM Forum Member
    Posted Mar 21, 2024 03:37

    See this post for guidance on using JSONPath query filters:
    RE: TMF Filter for an attribut that is an array of objects e.g TMF 639 resourceCharacteristic



    ------------------------------
    Vance Shipley
    SigScale
    ------------------------------