Open APIs

Expand all | Collapse all

TMF639 ResourceInventory and PATCH/DELETE

  • 1.  TMF639 ResourceInventory and PATCH/DELETE

    Posted 19 days ago
    Hi fellow tc guys,

    how would you suggest the PATCH/DELETE requests on resources should be implemented, when the resource id is not universally unique. The two requests don't seem to support a @type parameter either. So, how it is meant to be implemented?

    (In our organization the resource id is type-dependent.)

    Best regards,
    Daniel​​

    ------------------------------
    Daniel Rogowski
    NetCom BW
    ------------------------------


  • 2.  RE: TMF639 ResourceInventory and PATCH/DELETE

    TM Forum Member
    Posted 19 days ago
    Hi Daniel
    The assumption in TMF Open APIs is that the id of an entity is globally unique. So there will be no two Customer entities with the same id, no two Resource entities with the same id, etc.
    We should distinguish between this technical id (shall we say database sequence or GUID) and the value of a (logical) resource (e.g. TN, IP address), this value should be unique within the same type of resource.
    Does it help?

    ------------------------------
    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: TMF639 ResourceInventory and PATCH/DELETE

    Posted 18 days ago
    Hi Jonathan,

    thank you for your quick reply.

    We came up with the same idea you suggested. Additionally to our "internal primary keys" we added "external uuid's" to our entities. With the added value of looser coupling between both worlds.

    I was puzzled, because the TMF639 spec v. 4.0.1 on page 10 reads:

    "id    A string. Identifier of an instance of the resource. Required to be unique within the
    resource type. Used in URIs as the identifier for specific instances of a type"

    I interpret this as contradictory to what you wrote. Maybe this should be clarified in the next version.

    Best regards,
    Daniel​​​

    ------------------------------
    Daniel Rogowski
    NetCom BW
    ------------------------------



  • 4.  RE: TMF639 ResourceInventory and PATCH/DELETE

    TM Forum Member
    Posted 18 days ago
    Thanks Daniel for pointing this out. The general guidance for ids in Open APIs is that they are technical (and immutable), and you should not infer business meaning from them. To quote from TMF630 design guidelines:
    • The ID MUST be canonicalized and MUST not be a business identifier.
    • The ID must be unique and immutable within the collection.
    Looping in @Thomas Braun, the lead for Resource Inventory TMF639, maybe a text correction needs to be made there.

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