Open APIs

 View Only
  • 1.  TMF641

    Posted Nov 23, 2018 07:11
    Hi,

    we are trying to map our data model to TMF641. We have proprietary REST APIs and we are mapping these to TMF641. One thing that we have is "source" in the REST message header. This identifies the source of the request, e.g. "Billing_System_X". How can we map the source into TMF641? Maybe relatedParty?

    Thanks,
    Ronan

    ------------------------------
    Ronan Bracken
    Incognito Software Systems
    ------------------------------


  • 2.  RE: TMF641

    TM Forum Member
    Posted Nov 24, 2018 16:17
    Hi
    Related Party means just that, an Individual or Organization, not a software system. Software systems (e.g. billing system X) are modeled in TMF SID as resources (to best of my knowledge). But for simplicity I would suggest that you extend the service order schema by adding an explicit field for the source system, String sourceSystem, and populate with the name of the system when creating the service order.
    Adding @Ludovic Robert, who is the API lead for Service Order, since he may have additional insights.​

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    ------------------------------



  • 3.  RE: TMF641

    TM Forum Member
    Posted Nov 26, 2018 04:09
    Hello

    I will agree with @Jonathan Goldberg that I will prefer to use a dedicated attribute than relatedParty.
    One additional thought on this ... often we use a field in the HTTP header to log the requested application id (caller identification). To make a choice it will depends on the use of this field in the serviceOrder. If you consider it as a 'business field' ann make queries on them the first solution is better suited. If it just for log, the second could be enough.

    Hope it helps

    Ludovic​​

    ------------------------------
    Ludovic Robert
    Orange
    ------------------------------



  • 4.  RE: TMF641

    Posted Nov 26, 2018 10:58
    "often we use a field in the HTTP header to log the requested application id (caller identification)."

    We think that the "source" in the header is really important for tracking the source of the requests. We wanted to stay strictly to the Open API. Maybe this could be added to the specification of the Service Ordering Open API. For us, it makes most sense to be in the header.

    ------------------------------
    Ronan Bracken
    Incognito Software Systems
    ------------------------------