Open APIs

 View Only
  • 1.  Product and service order resourceref object

    Posted Jul 06, 2020 11:50
    I have been working on these two schemas and noticed that the resoureref structure is slightly different.  The product order structure includes a value attribute which isn't shown in the service order object.  I have been working on the assumptions that common objects used across the api's have consistent structures, could someone please confirm if this assumption is correct?  It may well be included in a guidelines document somewhere so please excuse me if I've missed it.

    Lynne

    ------------------------------
    Lynne Gregory
    SSE Electricity Ltd
    ------------------------------


  • 2.  RE: Product and service order resourceref object

    TM Forum Member
    Posted Jul 07, 2020 02:56
    Hi Lynne

    Can you be more specific as to exactly which schema element you are referring to. The parent ProductOrder and ServiceOrder resources do not have a value attribute. Value is an attribute of Characteristic, which is embedded in the Product and Service that are the subjects of the respective orders.

    In general you are correct that we aim to have commonality across the Open API schema, and work has been going on over the last year and more to increase this commonality and consistency.

    Looping in @Ludovic Robert as the SME for these two APIs.​

    ------------------------------
    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: Product and service order resourceref object

    Posted Jul 07, 2020 03:32
    Good morning

    It's specifically the resourceref element within TMF622 and TMF641 production versions.  This element has an attribute of 'value' in the product order spec which isn't included in the element within the service order spec.

    Hope this clarifies.

    Regards

    ------------------------------
    lynne gregory
    SSE Electricity Ltd
    ------------------------------



  • 4.  RE: Product and service order resourceref object

    TM Forum Member
    Posted Jul 07, 2020 11:03
    Thanks for the clarification, that helps.

    In the master schema, ResourceRef does not have attribute value, while LogicalResourceRef does have this attribute. This makes sense, since the value of a logical resource (e.g. MSISDN, IP address) is such a ubiquitous concept that we want it to be available in the entity reference.

    As far as I can see, the Product schema, which is used inside ProductOrder, refers to ResourceRef and not to LogicalResourceRef, and so value should not be present. The root cause is that the published Product Order swagger was generated against a ResourceRef version that had value, and this was subsequently moved to LogicalResourceRef (since value does not make sense for PhysicalResourceRef). And then Service Order was generated against this newer version of ResourceRef.

    Adding @Ludovic Robert, the focal for the Product Order API, and @Steve Harrop,

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



  • 5.  RE: Product and service order resourceref object

    Posted Jul 09, 2020 03:03
    That does help and is very clear, thank you, much appreciated.  I will remove the value attribute from the product order we've used.

    ------------------------------
    lynne gregory
    SSE Electricity Ltd
    ------------------------------