Open APIs

 View Only

  • 1.  Applying filtering

    TM Forum Member
    Posted Dec 05, 2018 09:09
    Hi all,
    I am implementing Product Inventory Management using Spring-boot framework, and more generally Java language, my question is: is there a recommended way or library to implement filtering criteria ?
    GET /product?fields=...&{filtering}


    ------------------------------
    Mohamed Kamel
    Vodafone Group
    ------------------------------


  • 2.  RE: Applying filtering

    Posted Dec 06, 2018 11:59
    Hi,
        As per tmforum rest API guidelines mentioned in the document TMF630_REST_Api_guidelines......filtering can be applied on resource attribute...please check the document for more details.

    Thanks
    Siva Solleti

    ------------------------------
    siva solleti

    ------------------------------

    Original Message


  • 3.  RE: Applying filtering

    Posted Jan 15, 2020 09:05
    Apparently the document on this page https://www.tmforum.org/resources/standard/tmf630-api-design-guidelines-3-0-r17-5-0/ is not available for download for members. Do you know how to get it?

    ------------------------------
    Valerio Santinelli
    TO BE VERIFIED
    ------------------------------

    Original Message


  • 4.  RE: Applying filtering

    Posted Jan 16, 2020 00:55
    You must be registered on the TM Forum Website & a member of a TM Forum Member Company to get access to this document.

    If you have additional questions or issues, please feel free to contact me directly,  kdilbeck@tmforum.org

    Regards, 

    Ken Dilbeck

    ------------------------------
    Ken Dilbeck
    TM Forum
    ------------------------------

    Original Message


  • 5.  RE: Applying filtering

    TM Forum Member
    Posted Feb 18, 2022 05:24
    Hi 

    We are using TMF 641 and TMF 638. Need help on how we can filter on a particular characteristic name value pair? 
    eg. name = Telephone and value = 0123456789
    TMF 630 does not seem to cover this.  

    Thanks
    Ninoshka Almeida
    Talktalk Group

    ------------------------------
    Ninoshka Almeida
    TalkTalk Group
    ------------------------------

    Original Message


  • 6.  RE: Applying filtering

    TM Forum Member
    Posted Feb 18, 2022 08:00
    Hi Ninoshka
    You are correct - the simple attribute filtering pattern will not not help you filter by characteristic.
    Suggest you take a look at the JSON Path filter description in Part 6 of the guidelines.
    Please bear in mind the following:
    • Your implementation of the API needs to support JSON Path filtering
    • Filtering by characteristic name and value can be quite expensive, unless your underlying storage (e.g. of the service inventory) includes relevant indices
    Hope it helps

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------

    Original Message


  • 7.  RE: Applying filtering

    TM Forum Member
    Posted May 09, 2023 07:14

    Thank you all for the valuable information. Sorry to ask, but Im still not 100% clear on how the notation would look like in this case. Lets say that I have one Characteristics array within the payload, If I have understood correctly, the way of notating the query based on two of the characteristics would be:

    GET {api-root}/document/? filter="[ {characteristic.contains = [ {name=watermarkOutput,value=1001} || {name=documentType,value=pdf } ] } ]

    Would this be correct?

    Much appreciated your help.



    ------------------------------
    manuel pastor
    Salesforce
    ------------------------------

    Original Message