Planning Analytics

Planning Analytics

Get AI-infused integrated business planning

 View Only
  • 1.  Version of APIs

    Posted 11/25/20 03:34 AM
    Hi, 

    Short question.
    How is the versions of APIs handled in order to ensure compatibility?

    BR, 
    Alexander

    ------------------------------
    Alexander Jarl
    ------------------------------

    #PlanningAnalyticswithWatson


  • 2.  RE: Version of APIs

    Posted 11/26/20 07:15 AM
    Hi Alexander,

    Are you inquiring generically for APIs in PA or are you asking thinking about a specific API, like TM1 server's REST API for example?

    Cheers,

    ------------------------------
    Hubert Heijkers
    ------------------------------



  • 3.  RE: Version of APIs

    Posted 11/27/20 03:42 AM
    Just to elaborate for a bit;

    IMHO, API's should only make changes in a way that they would not be breaking existing clients, if they were to break existing clients they should make a new version available on a different URL.

    WRT to TM1's REST API, TM1's REST API is OData compliant and as such strictly adheres to the model versioning rules as specified in the OData Protocol Specification.
    Be aware that we do include the, later introduced, Core.SchemaVersion annotation to express the last TM1 server version that caused a change to its REST API but, unlike implied, in our case we continue to guarantee backwards compatibility. We also apply the Core.Revisions annotation to specify with which version something new was added and/or deprecated in the REST API. But even when deprecated, we'll guarantee support for such elements of the API for all versions of TM1 until at least the next major version.
    As such TM1's REST API, since its introduction in May 2014, in TM1 10.2.2, is still on its first version (v1) and all the extensions/changes made since have been within the model versioning rules as referenced above.

    ------------------------------
    Hubert Heijkers
    ------------------------------