Open APIs

Expand all | Collapse all

Does TMF639 support multiple resource inventory object in a single request?

  • 1.  Does TMF639 support multiple resource inventory object in a single request?

    TM Forum Member
    Posted Jun 18, 2021 10:56
    Edited by Marlon Almazan Jun 20, 2021 11:55
    Hi,
    According to TMF 639, can we create multiple Resource Inventory object in a single call/request ?
    https://www.tmforum.org/resources/specification/tmf639-resource-inventory-api-user-guide-v4-0/" target="_blank" rel="noopener">TMF639 specification   page 14 , Section "ResourceRelationship sub-resource"  mentiones about the bundled resources .
    But these is not example given any where.
    If supported can you pls share an example of the same.

    Regards
    Kiran


  • 2.  RE: Does TMF639 support multiple resource inventory object in a single request?

    TM Forum Member
    Posted Jun 21, 2021 01:33
    Hi Kiran
    All write operations (Create, Update, Delete) in the entity-based Open APIs work on a single entity only. Of course, if the entity contains sub-entities (e.g. orders have order items, products and resources can have nested products and resources), the operations can apply to the entity and all of its contained sub-entities.
    If you want to work on multiple independent entities, you will have to create a task API and resource to deal with the list. And you'll have to deal with the complexity of partial success, increased latency, and more.
    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.
    ------------------------------



  • 3.  RE: Does TMF639 support multiple resource inventory object in a single request?

    TM Forum Member
    Posted Jun 21, 2021 10:53
    Thank you very much Jonathan for the valuable information.
    yes we are looking for creating a parent and child Resource Inventory entity in the same Request.
    So are you confirmed , it should be possible in current TMF 639 spec.

    Do we have any ref implementation of this Parent and child entity Resource inventory object ?
    also if you have a postman example please share.

    Regards
    Kiran

    ------------------------------
    Kiran
    ------------------------------



  • 4.  RE: Does TMF639 support multiple resource inventory object in a single request?

    TM Forum Member
    Posted Jun 21, 2021 11:59
    Hi Kiran
    All published assets for the API (including RI and postman scrips) can be found in its entry on the Open API table here. I don't know if the postman script includes such an example but you can take a look there.
    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: Does TMF639 support multiple resource inventory object in a single request?

    TM Forum Member
    Posted Jun 28, 2021 12:02
    Thank you Jonathan Goldberg for your valuable information.
    In the ref provided in Open API Table postman collection , only 'Creates  a Resource' example is present.
    Can't find any example for creating parent and child in a single request. where can I find this example?

    Also on ref implementation server "tmf639-resourceinventory-v4.mybluemix.net"  , "Create a Resource" API is not working.
    It Fails with following error
    "Internal database error" .
    How can fix this issue?

    Regards

     


    ------------------------------
    Kiran
    ------------------------------



  • 6.  RE: Does TMF639 support multiple resource inventory object in a single request?

    TM Forum Member
    Posted Jun 28, 2021 12:10
    Hi Kiran
    Specific problems with the CTK and Postman need to be taken up with the TMF support focals, @Henrique Rodrigues and @Victor Mari.
    Regarding more complex content in Postman samples, I honestly don't know what the criteria for generating content. Perhaps @Ludovic Robert, lead for this API, knows.
    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.
    ------------------------------



  • 7.  RE: Does TMF639 support multiple resource inventory object in a single request?

    TM Forum Member
    Posted Jun 21, 2021 15:41
    Hi Kiran,

    TMF639 does currently not specify the automatic creation of subresources. It does however also not prevent an implementation to do so.
    When you want to create an instance of a 24 port ethernet switch in the inventory, your probably want to create the switch with its 24 port using a single call instead of making 25 calls.

    The current TMF639 / TMF634 specifications seems a bit incomplete to model this. I am proposing to extend the ResourceCandidate model to allow the creation of such cascaded models. I am planning to make a contribution in this sense.

    Regards

    ------------------------------
    Koen Peeters
    Ciminko Luxembourg
    ------------------------------



  • 8.  RE: Does TMF639 support multiple resource inventory object in a single request?

    TM Forum Member
    Posted Jun 29, 2021 02:57
    Hello,

    I have a different perspective from Koen for this point. For me, the API model allow you to create a resource (Class Resource) with a resource relationship (class ResourceRelationship) targeting a Resource created by value (class ResourceRefOrValue). By leveraging this, I do not see why you cannot create in a single POST a cluster of resource?

    The challenge is on the server side to create this bunch of entities and to manage potential issues.

    Indeed, there is no example provided.

    Ludovic

    ------------------------------
    Ludovic Robert
    Orange
    My answer are my own & don't represent necessarily my company or the TMF
    ------------------------------



  • 9.  RE: Does TMF639 support multiple resource inventory object in a single request?

    Posted Jul 23, 2021 12:55
    Thank you very much Jonathan for the valuable information.

    ------------------------------
    vikrampaul vikrampaul
    TO BE VERIFIED
    ------------------------------



  • 10.  RE: Does TMF639 support multiple resource inventory object in a single request?

    TM Forum Member
    Posted Aug 16, 2021 09:52
    Hi Ludovic,
    Your approach could also be used to create other sub-entities which are specified by value, such as Resource.attachment (type AttachmentRefOrValue).
    What is your view on this?

    ------------------------------
    Sanver Narin
    PiA Bilişim Hizmetleri A.Ş.
    ------------------------------



  • 11.  RE: Does TMF639 support multiple resource inventory object in a single request?

    TM Forum Member
    Posted Aug 16, 2021 09:52
    Hi Ludovic,
    Your approach could also be used for creating other objects within the same operation, for example when Resource.attachment (type AttachmentRefOrValue) specifies an attachment by value.
    This pattern effectively transforms the API into an aggregator role, managing the creation of multiple entities of different types.
    What would be your thoughts on this?

    ------------------------------
    Sanver Narin
    PiA Bilişim Hizmetleri A.Ş.
    ------------------------------



  • 12.  RE: Does TMF639 support multiple resource inventory object in a single request?

    TM Forum Member
    Posted Aug 16, 2021 10:53
    Hi Sanver

    Yes, for me same pattern could be used and in your case several attachments will be created in parallel with the resource creation. I'm not sure that this is "supper clean" REST behavior, but this pattern defined in the API allows this creation aggregation. An issue could occur if the server is not able to handle this composite request synchronously, but in this case the Monitor pattern could be used to supervise this complex request.

    Ludovic

    ------------------------------
    Ludovic Robert
    Orange
    My answer are my own & don't represent necessarily my company or the TMF
    ------------------------------



  • 13.  RE: Does TMF639 support multiple resource inventory object in a single request?

    TM Forum Member
    Posted Aug 17, 2021 04:38
    Well, I believe this approach is at least "clean enough".
    In any case, I cannot see a violation of REST principles here.
    Thanks a lot for your comments Ludovic.


    ------------------------------
    Sanver Narin
    PiA Bilişim Hizmetleri A.Ş.
    ------------------------------