Open APIs

 View Only
  • 1.  TMF620 - Return facets data

    TM Forum Member
    Posted Jun 13, 2022 08:12
    Hello,

    /productOffering endpoint returns an array of ProducOffering Entities
    as the following
    [
        {
            "id": "product offering 1",
            .....
        },
        {
            "id": "product offering 2",
            .....
        },
        ....
    ]​

    we need to return to Facets data with this JSON
    Example
    {
        "data": [
            "id": "product offering 1",
            .....
        },
        {
            "id": "product offering 2",
            .....
        },
        ....
    ],
    "facets": {
            "Memory": [
                {
                    "value": 64,
                    "count": 2
                },
                {
                    "value": 32,
                    "count": 7
                }
            ],
            "Storage": [
                {
                    "value": 128,
                    "count": 20
                }
            ]
        }
    }​


    How can i do something like that with the rules of TMF?



    ------------------------------
    Moustafa Elkady
    Vodafone Group
    ------------------------------


  • 2.  RE: TMF620 - Return facets data

    TM Forum Member
    Posted Jun 13, 2022 10:13
    Hi Moustafa
    Can you explain what you mean by "facets". I'm not aware of any such entity or class in the Open API model, but perhaps I missed something.

    ------------------------------
    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.
    ------------------------------



  • 3.  RE: TMF620 - Return facets data

    TM Forum Member
    Posted Jun 14, 2022 05:25
    Edited by Moustafa Elkady Jun 14, 2022 05:26
    Something like this Search API facets | Elastic App Search Documentation [8.2] | Elastic

    Where can I add this json? do i need to make an extension or something?

    https://en.wikipedia.org/wiki/Faceted_search

    ------------------------------
    Moustafa Elkady
    Vodafone Group
    ------------------------------



  • 4.  RE: TMF620 - Return facets data

    TM Forum Member
    Posted Jun 14, 2022 05:28
    If you're talking about Facets data visualizations for ML dataset, it is the responsibility of your implementation to consume and transform the the data provided by TMF620. your need is beyond the scope of the API.

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

    Matthieu Hattab
    Lyse Platform
    ------------------------------



  • 5.  RE: TMF620 - Return facets data

    TM Forum Member
    Posted Jun 14, 2022 05:33
    Thank you, but I didn't get you,
    I'm asking about the JSON representation, I have this data, how can I make the TMF620 produce this data

    ------------------------------
    Moustafa Elkady
    Vodafone Group
    ------------------------------



  • 6.  RE: TMF620 - Return facets data

    TM Forum Member
    Posted Jun 14, 2022 05:54
    I know, but TMF will not expose the JSON in the way you want. TMF620 has an agreed JSON representation. If you need a different format/representation, it is the responsibility of your implementation to consume and transform the data provided by TMF620.

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

    Matthieu Hattab
    Lyse Platform
    ------------------------------



  • 7.  RE: TMF620 - Return facets data

    TM Forum Member
    Posted Jun 14, 2022 06:26
    The short answer is: you can't.
    The output you are requesting is not TMF620 compliant.

    That doesn't prohibit you from creating your own API that provides this result.
    Using the TMF630 JSONPath expressions you could probably create several queries that each provide part of your answer. You can then combine these answers in one payload. If you have a TMF620 compliant system you could create a microservice that does the quering and recombining for you and return everything in  the requested format.

    ------------------------------
    Koen Peeters
    OryxGateway
    ------------------------------