Planning Analytics

Planning Analytics

Get AI-infused integrated business planning

 View Only
Expand all | Collapse all

Planning Analytics Workspace REST API in 2.1.21 and 3.1.8

  • 1.  Planning Analytics Workspace REST API in 2.1.21 and 3.1.8

    Posted 06/01/26 06:30 PM

    Planning Analytics Workspace releases 2.1.21 and 3.1.8 introduces an officially supported REST API.  Documentation for this feature in 2.1.21 can be found here.

    The product team is working on a swagger page to document the specific API endpoints.  in the mean time, I have put together a Postman collection that highlights the specific endpoints available in Workspace here.  The list of available endpoints will expanded with future PAW releases.



    ------------------------------
    Stuart King
    Product Manager
    IBM Planning Analytics
    ------------------------------


  • 2.  RE: Planning Analytics Workspace REST API in 2.1.21 and 3.1.8

    Posted 06/02/26 03:39 AM

    Thanks a lot Stuart!



    ------------------------------
    Wim Gielis
    Senior Consultant
    Aexis International
    Sint-Stevens-Woluwe
    +32496225001
    ------------------------------



  • 3.  RE: Planning Analytics Workspace REST API in 2.1.21 and 3.1.8

    Posted 06/03/26 03:27 AM

    thanks a lot!



    ------------------------------
    Vitalij Rusakovskij
    ------------------------------



  • 4.  RE: Planning Analytics Workspace REST API in 2.1.21 and 3.1.8

    Posted 06/03/26 05:26 AM

    Nice, thanks for posting this.

    Is your Postman collection complete as of now or are those only examples or highlights? I'm especially wondering about adding users or groups to PAW. Or might this be a feature planned for a future release?



    ------------------------------
    Matthias Holthus
    ------------------------------



  • 5.  RE: Planning Analytics Workspace REST API in 2.1.21 and 3.1.8

    Posted 06/21/26 07:12 AM

    I am extensively using AI coding tools. It would be good if the new APIs allow me to create anything I want that is currently being done through the UI. E.g. creating books and applications.



    ------------------------------
    Filip Lou
    Sr Technical Account Digital Business Automation
    IBM
    Sydney
    ------------------------------



  • 6.  RE: Planning Analytics Workspace REST API in 2.1.21 and 3.1.8

    Posted 07/01/26 03:35 PM

    @STUART KING - Any updates on the swagger page being available?  



    ------------------------------
    Roman Harasymiak
    ------------------------------



  • 7.  RE: Planning Analytics Workspace REST API in 2.1.21 and 3.1.8

    Posted 17 days ago

    Hi Stuart, thank you for sharing the Postman collection, it has been very helpful while exploring the new PAW REST API.

    After filling in the required variables, I was able to get the other endpoints working as expected. However, I noticed that the Start TM1 Database and Stop TM1 Database requests consistently return 404 Not Found in my environment. Are these endpoints not yet available in the current releases, or is there a different URL or approach that should be used for these operations?

    Thanks in advance!



    ------------------------------
    Daniel Corbellini
    ------------------------------



  • 8.  RE: Planning Analytics Workspace REST API in 2.1.21 and 3.1.8

    Posted 17 days ago

    Hi Daniel,

    The September update (2.1.24 for Planning Analytics on Cloud, 3.1.11 for PA SaaS) will include a number of new PAW REST API endpoints.  I'll update the Postman collection with the list of upcoming endpoints.  I can confirm we are adding supported endpoints for users, groups, and database management.  This will include options that mirror the buttons in PAA database details.

    Here is a bit of a sneak peak.



    ------------------------------
    Stuart King
    Product Manager
    IBM Planning Analytics
    ------------------------------



  • 9.  RE: Planning Analytics Workspace REST API in 2.1.21 and 3.1.8

    Posted 17 days ago

    Awesome!



    ------------------------------
    Vitalij Rusakovskij
    ------------------------------



  • 10.  RE: Planning Analytics Workspace REST API in 2.1.21 and 3.1.8

    Posted 17 days ago

    Hi Stuart,

    thanks a lot for the continuous updates and the Postman collection – very helpful!

    Quick question regarding the Content endpoints (Books / Applications):

    Does GET Get asset content by asset ID already return the full internal structure of a Book in a usable way (sheets, widgets, action buttons with their settings, parameters, synchronizations, etc.)?

    Or is deeper introspection / programmatic creation and modification of the internal Book content still planned for a later release?

    This would be extremely useful for automation scenarios.

    Thanks in advance!



    ------------------------------
    Vitalij Rusakovskij
    ------------------------------



  • 11.  RE: Planning Analytics Workspace REST API in 2.1.21 and 3.1.8

    Posted 16 days ago

    Hi Vitalij,

    The full book specification is returned by the GET.  At some point in the future we will likely investigate more granular API endpoints to investigate, interact with, and modify books.  However, this is not on our roadmap for 2026.  



    ------------------------------
    Stuart King
    Product Manager
    IBM Planning Analytics
    ------------------------------



  • 12.  RE: Planning Analytics Workspace REST API in 2.1.21 and 3.1.8

    Posted 16 days ago

    Hi Stuart,
    thanks a lot for the quick and clear answer. It's helpful to know that the full book specification is already returned. I'll explore automation scenarios based on that for now. More granular endpoints would of course be very valuable in the future, but good to have a realistic view on the 2026 roadmap.

    Best regards Vitalij



    ------------------------------
    Vitalij Rusakovskij
    ------------------------------



  • 13.  RE: Planning Analytics Workspace REST API in 2.1.21 and 3.1.8

    Posted 13 days ago

    Hi Stuart,

    Thanks for all the information you provide.

    I have a small question about the content of the book.

    The view definition is encoded but I cannot figure how. I thought it was Base64 but the reverse is not what I expected.

    Could you provide some help on this ?



    ------------------------------
    David Boublil
    ------------------------------



  • 14.  RE: Planning Analytics Workspace REST API in 2.1.21 and 3.1.8

    Posted 13 days ago

    Hello David,


    In fact it's base 64 encoded with kind of zip in it. I can send you a code sample in Python to handle it.



    ------------------------------
    Wim Gielis
    Senior Consultant
    Aexis International
    Sint-Stevens-Woluwe
    +32496225001
    ------------------------------



  • 15.  RE: Planning Analytics Workspace REST API in 2.1.21 and 3.1.8

    Posted 3 days ago

    Hi Stuart,

    Thanks! 

    Questions specifically for v12:  The TM1 REST API query for Threads doesn't seem to return anything in Postman, e.g,   https://westus3.planninganalytics.saas.ibm.com/api/<TENANTID>/v0/tm1/<DBNAME>/api/v1/Threads?$expand=Session

    returns:  

    {
        "@odata.context": "$metadata#Threads(Session)",
        "value": []
    even if a process script has been executing for some time.  I would have expected to see that thread in the response. 
    Is there a way to get threads in v12? 
    Does tm1.CancelOperation work in v12?  If so, how does one retrieve the thread ID to use in a call to tm1.CancelOperation?  
    Thanks,
    Chris


    ------------------------------
    Christopher Wolfe
    ------------------------------



  • 16.  RE: Planning Analytics Workspace REST API in 2.1.21 and 3.1.8

    Posted 3 days ago

    Hi Stuart,

    I wanted to use the PAW API through VBA code and the PAfE APIs, to benefit from the PAfE connexion, but it does not seem to work.

    I am not sure it is supposed to work but wanted to try as I am already using PAfE with TM1 Rest APIs to do some automatic documentation.

    Should I try another approach ?



    ------------------------------
    David Boublil
    ------------------------------



  • 17.  RE: Planning Analytics Workspace REST API in 2.1.21 and 3.1.8

    Posted 2 days ago

    Hi Christopher,

    The Threads API endpoint does not return anything in TM1 12 (it's a deprecated endpoint).  Use /Jobs instead.

    e.g https://us-east-1.planninganalytics.saas.ibm.com/api/v1/tm1/Planning Sample/api/v1/Jobs?$expand=*



    ------------------------------
    Stuart King
    Product Manager
    IBM Planning Analytics
    ------------------------------



  • 18.  RE: Planning Analytics Workspace REST API in 2.1.21 and 3.1.8

    Posted 2 days ago

    Hi David,

    Can you get the same API calls to work outside of Excel (in Postman)?  I am not very familiar with using TM1 or PAW API calls from VBA.  It might help to see the specific API calls that are failing and the error message. 



    ------------------------------
    Stuart King
    Product Manager
    IBM Planning Analytics
    ------------------------------



  • 19.  RE: Planning Analytics Workspace REST API in 2.1.21 and 3.1.8

    Posted 2 days ago

    Hi Stuart,

    The PAW API I am trying to use is "/api/v1/content/users" which works fine with podman and OAUTH.

    I wanted to use it throught PAfE VBA API "Reporting.GetConnection(sUrl).GET(strUrl).ToString" to benefit from the PAfE connection as I ususaly do with TM1 REST API.

    I get an authentication error : 'Cognos.Office.Framework.DataSource.HTTPAuthenticationException'



    ------------------------------
    David Boublil
    ------------------------------