Open APIs

Expand all | Collapse all

History in apis

  • 1.  History in apis

    TM Forum Member
    Posted Apr 15, 2019 08:38
    Hi All,
    Is there standard way to refer history of an object in the TMForum open apis?.
    For e.g. I call the Party Management API to update an  Individual's given name from "Jon" to "John".  /individual/123 will give me the latest information i.e "John". Is there a standard way for asking the previous version of Individual before the update happened?

    Shibin CK

  • 2.  RE: History in apis

    TM Forum Member
    Posted Apr 15, 2019 09:06
    Specific APIs expose a limited functionality in this area, according to the judgment of the API lead designer, when there is a clear business justification. For example:
    • The various Catalog Management APIs support retrieval of catalog resources by version. Note that setting a new version is an explicit activity done by the catalog maintainer, 
    • Trouble Ticket and Service Problem have sub-entities showing status changes by date
    But there is no overall pattern for accessing the state of a resource by arbitrary date. Perhaps it is felt that this is functionality that should be handled by audit logs and the like, rather than in business APIs. And/or it is not reasonable to expect API implementors to maintain entity history for every entity (considering the storage required for millions/tens of millions/more entities).

    Jonathan Goldberg
    Amdocs Management Limited