Open APIs

 View Only
  • 1.  TMF 648 19.0.0 AgreementRef and AgreementItemRef

    TM Forum Member
    Posted Sep 26, 2019 11:09
    Edited by Konstantin Tarasov Sep 26, 2019 12:13
    Hi team,

    In 19th version of Quote TMF API a new class AgreementItemRef has been introduced.
    The description is a bit confusing:
    Agreement Item Ref is a reference to an Agreement Item that belongs to an Agreement.
    In AgrementItemRef.id should be Id of the Agreement Item and in AgrementItemRef.agreementId we should specify Id of the Agreement. 
    Or AgreementItemRef is a reference to the Agreement and in AgrementItemRef.agreemenItemtId we should specify Id of the AgreementItem?



    ------------------------------
    Konstantin Tarasov
    Netcracker Technology
    ------------------------------


  • 2.  RE: TMF 648 19.0.0 AgreementRef and AgreementItemRef

    TM Forum Member
    Posted Oct 02, 2019 09:26
    Hi Konstantin
    We discussed this just now in our API team meeting - there has been an error in our schemas that caused the duplicate attributes (name + name, and id + agreementItemID). We have an open JIRA issue for this so hopefully it will be corrected, meaning that agreementItemID will be removed and the double name will be removed.
    Generally, Ref entities are pointers to full entities, and will have id, href, and name - specific ref entities may have a small number of additional attributes as determined by design needs.
    So AgreementItemRef.id should contain the id (primary key) of the agreement item (and agreementItemID will hopefully be removed).
    Hope it helps

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



  • 3.  RE: TMF 648 19.0.0 AgreementRef and AgreementItemRef

    TM Forum Member
    Posted Oct 02, 2019 09:53
    Hi Jonathan,

    Thanks for your answer.
    Have you considered keeping agreementId in AgreementItemRef? 
    An Agreement Item always has a context of the Agreement to which it belongs and it would be helpful to have agreementId in AgreementItemRef.


    ------------------------------
    Konstantin Tarasov
    Netcracker Technology
    ------------------------------



  • 4.  RE: TMF 648 19.0.0 AgreementRef and AgreementItemRef

    TM Forum Member
    Posted Oct 02, 2019 10:24
    Hi Konstantin

    I think I may have answered too hastily, apologies for the confusion - I have now looked in more detail and it seems that AgreementItem is a sub-entity of Agreement, and not an independently managed entity at all (and so AgreementItem has no ID or href). So in order to be addressable (it is used in Product) the AgreementItemRef should actually point to the Agreement (i.e. the id, href are of the Agreement) and then the agreementItemID in the Ref is an internal index of the item in the agreement.
    BUT - AgreementItem does not have this index :(
    So we will need to fix this - I will update the JIRA accordingly, but I cannot commit to when the fix to the API will be made, since I am not the subject matter expert for this API.

    Again apologies for the confusion and I hope it is now understandable.

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