Planning Analytics

Planning Analytics

Get AI-infused integrated business planning

 View Only
  • 1.  Planning Analytics 3.x on-prem REST API

    Posted 02/20/26 11:23 AM
    We're evaluating the 3.x Tech Preview on‑prem, and I'm exploring the REST API. Does anyone have a simple example using ExecuteHttpRequest to call a process in Database A from Database B?
    Specifically, I need to execute:
    https://myPA31URL/api/tenantId/v0/tm1/MySouceDB/api/v1/Processes('myTIProcess')/tm1.Execute via ExecuteHttpRequest.
    I'm signing in to PA 3.x with Windows authentication and need clarity on whether ExecuteHttpRequest requires explicit auth parameters. If it does, can someone provide a simple example demonstrating ExecuteHttpRequest with Windows Integrated Security?
    Thanks


    ------------------------------
    Matteo Lorini
    ------------------------------


  • 2.  RE: Planning Analytics 3.x on-prem REST API

    Posted 02/23/26 07:27 AM

    Hi Matteo,

    Trust you've seen the documentation for ExecuteHttpRequest and that you are familiar with the HTTP protocol. And to add some context, hoping you are familiar with cURL, think of ExecuteHttpRequest as a light-weight version of cURL build into TI but limited to HTTP.

    With that in mind the question of having to specify an authentication header, or the '-u' username:password for basic authentication shortcut, with your HTTP request which you are preforming using ExecuteHttpRequest depends on the service you are targeting. In this case the target is a PA 3.1 service (not TM1 directly) in which case the answer is not only 'Yes' you'll need to follow a device-code-flow with your OIDC provider, the one you used to configure PAL 3.1, and then pass the resulting token in the 'Authorization' header as in: `Authorization: Bearer <token>`. Truth be told though, not sure if this pattern is already documented in the preliminary PAL 3.1 docs.

    But all that said I notice you are talking about Windows Integrated Security. Not that it is impossible to use Windows Integrated Security with PAL 3.1, or TM1 v12 for that matter, but neither have support for Windows Integrated Authentication build in any longer, so how did you set that up? What OIDC provider are you using to bridge between the two?

     



    ------------------------------
    Hubert Heijkers
    STSM, Program Director TM1 Functional Database Technology and OData Evangelist
    ------------------------------



  • 3.  RE: Planning Analytics 3.x on-prem REST API

    Posted 03/06/26 10:01 AM
    Thanks for your response. I'm evaluating whether it's possible to upload a file from PA 3.x on‑prem to Databricks. The following curl command works fine and allows me to upload a file to Databricks.

    curl -X PUT  "<DataBricks URL>/api/2.0/fs/files/Volumes/<My DataBricks Target Directory>/dropbox/<My File Name>.csv" -H "Authorization: Bearer <My Databricks Token>"   -H "Content-Type: application/octet-stream"  --data-binary @/Users/<my Local ID>/Downloads/My Local File Name>.csv  

    My next step was to develop an ExecuteHttpRequest implementation that replicates the exact behavior of the cURL command used to upload the file. Unfortunately, I wasn't able to get it working. My suspicion is that it may not be possible to upload or download files directly to or from Databricks-or any cloud‑based storage-using this approach.
    If ExecuteHttpRequest is considered a lightweight version of cURL, what are its limitations?
    Thanks


    ------------------------------
    Matteo Lorini
    ------------------------------



  • 4.  RE: Planning Analytics 3.x on-prem REST API

    Posted 03/06/26 10:23 AM

    Hi Matteo,

    If it's HTTP then there shouldn't be anything that CURL can do that ExecuteHttpRequest can't (that I'm aware of). Your example above should work just fine as in:

    ```
    ExecuteHttpRequest(
    'PUT',
    '<DataBricks URL>/api/2.0/fs/files/Volumes/<My DataBricks Target Directory>/dropbox/<My File Name>.csv',
    '-h Authorization: Bearer <My Databricks Token>',
    '-h Content-Type: application/octet-stream',
    '-d @/Users/<my Local ID>/Downloads/My Local File Name>.csv' );

    ```



    ------------------------------
    Hubert Heijkers
    STSM, Program Director TM1 Functional Database Technology and OData Evangelist
    ------------------------------



  • 5.  RE: Planning Analytics 3.x on-prem REST API

    Posted 03/06/26 11:09 AM

    Thanks again for your quick response. The cURL request is over HTTPS rather than HTTP-does that make any difference?

    Also, thank you for pointing me to Jessica's article. I do have another question: under my PAW 3.1.0‑technologypreview1 profile, I only see the following options:

    • Profile and Settings
    • About IBM Planning Analytics
    • Sign out

    Even though I am the administrator, I do not see the "Manage API Keys" menu.

    Thanks



    ------------------------------
    Matteo Lorini
    ------------------------------



  • 6.  RE: Planning Analytics 3.x on-prem REST API

    Posted 03/06/26 10:32 AM

    Hi Matteo,

    @Jessica Nicholls has published a blog on working with Files and the API that is well worth a read and should point you in the right direction:

    https://community.ibm.com/community/user/blogs/jessica-nicholls/2025/02/03/managing-paaas-with-apis 

    I believe the are also examples of files being moved from/ to Box/ Dropbox in the Community as well



    ------------------------------
    Edward Stuart
    Solutions Director
    Spitfire Analytics Limited
    Manchester
    ------------------------------



  • 7.  RE: Planning Analytics 3.x on-prem REST API

    Posted 03/08/26 11:17 AM
    Hello Matteo,

    Thank you very much for sharing the update regarding Planning Analytics 3.x on-prem REST API. I sincerely appreciate you taking the time to contribute such valuable information to the community. Updates like these are extremely helpful for learners, developers, and professionals who are interested in understanding the evolving ecosystem of enterprise analytics platforms.

    The continuous development of IBM Planning Analytics is truly inspiring. The expansion of REST API capabilities in particular represents a significant step toward improving interoperability, automation, and seamless integration with modern data systems. In the current era where organizations rely heavily on data-driven strategies, having flexible programmatic access to analytics and planning environments allows developers and analysts to design more intelligent workflows, integrate multiple platforms efficiently, and automate complex business processes.

    From my perspective as a Computer Science student, this type of advancement is very exciting because it bridges the gap between theoretical knowledge and real-world applications. Modern analytics platforms are no longer isolated systems; instead, they are becoming part of a broader intelligent ecosystem where artificial intelligence, data engineering, and advanced visualization tools work together. REST APIs play a key role in enabling such ecosystems by allowing different technologies to communicate and exchange information in a structured and scalable way.

    Personally, I am very passionate about exploring emerging technologies in the fields of artificial intelligence, data analytics, and intelligent automation. My academic journey has motivated me to look beyond traditional software development and focus on how advanced technologies can be used to build impactful and innovative solutions. Currently, I am working on strengthening my understanding of analytics platforms, data pipelines, and AI-based decision support systems.

    As part of my learning plan, I intend to explore the architecture and capabilities of IBM Planning Analytics in greater depth. I am particularly interested in understanding how REST APIs can be leveraged to automate planning processes, integrate analytical models with other enterprise systems, and create intelligent applications that support strategic decision-making. My goal is not only to understand the theoretical aspects of such technologies but also to experiment with them through practical projects and research-oriented initiatives.

    In the near future, I am planning to work on innovative projects that combine artificial intelligence, machine learning, and advanced analytics. I strongly believe that the integration of these technologies can transform the way organizations approach planning, forecasting, and resource optimization. By combining AI-driven insights with powerful analytics platforms, it becomes possible to create smarter systems that can adapt, learn from data, and support better long-term decision making.

    In addition to academic exploration, I am also interested in contributing to discussions and knowledge sharing within the technology community. Platforms like this provide a great opportunity to learn from experienced professionals, stay informed about technological developments, and exchange ideas that can inspire new innovations.

    Once again, thank you for sharing this valuable update. I truly appreciate the effort taken by contributors and professionals who actively share knowledge and keep the community informed about the latest advancements. I look forward to learning more about the practical applications of Planning Analytics and exploring how its REST API capabilities can be utilized to build meaningful and impactful solutions.

    Best regards,
    Kadambini Pujari
    Department of Computer Science Engineering
    Faculty of Engineering and Technology (Exclusively for Women)
    Sharnbasava University