Open APIs

Expand all | Collapse all

TMF 639 Resource Inventory Management Model

  • 1.  TMF 639 Resource Inventory Management Model

    Posted 16 days ago
    Edited by Umashankar Nair 16 days ago
    Hi All,

    We are bringing in additional support for a REST API based NBI in our existing EMS system in addition to the existing. I have  a few doubts with respect to the json schema

    1. In the definition for Resource i find there are 2 definitions for Resource viz: Resource and Resource_Update. I would like to know the difference between the two and which of them have to be considered for the implementation
    2. Similarly for the logical resources also i find multiple definitions.
    3. Are there any converters available to convert the json schema to Java POJO classes.

    It would be great If someone could clarify this.

    Also, i would like to download the REST API design guidelines, however, i find that the links are not enabled in my login. Do i have to subscribe to the TMF forum to download these files.

    Regards,
    Umashankar

    ------------------------------
    Umashankar Nair
    Alphion Corporation
    ------------------------------


  • 2.  RE: TMF 639 Resource Inventory Management Model

    TM Forum Member
    Posted 16 days ago
    Umashankar,

    You should create ResourceSpecifications for the managed object classes (MOC) used in your EMS. These should be managed with TMF634 Resource Catalog API. Your managed object instances (MOI) should be Resources managed with TMF639 Resource Inventory API with the value of the resourceSpecification attribute being a reference to the ResourceSpecification for the MOC of which the MOI is an instance of.

    You may find IG1217 a useful reference. Although it is specifically about 3GPP information models the same patterns apply for other domains (e.g. transport).


    ------------------------------
    Vance Shipley
    SigScale
    ------------------------------



  • 3.  RE: TMF 639 Resource Inventory Management Model

    Posted 13 days ago
    Hi Vance Shipley,

    Thank you very much. It helped

    Regards 


    ------------------------------
    Umashankar Nair
    Alphion Corporation
    ------------------------------



  • 4.  RE: TMF 639 Resource Inventory Management Model

    TM Forum Member
    Posted 16 days ago
    Hi Umashankar
    1 and 2. The Open API swagger files are generated by tooling from a unified schema repository. For primary (managed) entities with POST operations we generate an <Entity>_Create resource, and for primary (managed) entities with PATCH operations we generate an <Entity>_Update resource - these resources are derived from the main entity definition but exclude attributes that are determined not to be relevant (e.g. non-patchable attributes will not be present in the <Entity>_Patch resource.
    3. TMF does not supply such, but there are plenty of opensource tools out there. You could try Jackson for example. Disclaimer - I have not personally used Jackson and I take no responsibility for this recommendation.

    Please note that the TMF has a number of tiers for accessing materials. I'm not an expert on this, but here's what I know:
    • Some stuff is freely available to everyone (I guess white papers, web articles, etc.)
    • Some stuff, for example published Frameworx assets, Open API assets, etc., is available only to TMF members. If your company is a member of TM Forum (see the list here - I didn't see Alphion but perhaps you are there under a different name) you can sign up with your work email address at the TMF registration page and gain access to these assets.
    • Some stuff, such as non-published work in progress in collaboration projects (such as Open API) is available only to people who join those specific projects.
    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: TMF 639 Resource Inventory Management Model

    Posted 13 days ago
    Hi Jonathan Goldberg,

    Thank you for the response. It helped.

    Regards


    ------------------------------
    Umashankar Nair
    Alphion Corporation
    ------------------------------