IBM Support

Planning Analytics TM1 12 REST API Does Not Return Expected ServerName Value

Troubleshooting


Problem

REST API responses from Planning Analytics TM1 databases which include the ServerName, do not return the expected server name (database name)

Symptom

  • A Planning Analytics (as a service) database exists, with the following name: TestDB
  • REST API responses from the database do not return TestDB as the ServerName
  • Instead, the following ServerName format is returned: tm1-i-cn0j6ogaeuucfslk7u40-d-cobambudl2os2qg56cp0
     

Resolving The Problem

This behaviour is expected.  Planning Analytics TM1 Databases deployed on Planning Analytics as a Service and Planning Analytics Advanced Certified Containers, return a ServerName in the format of tm1-i-unique-identifier.  The ServerName returned by the REST API is the expected ServerName for the service (unique identifier).

To retrieve a list of databases with their given name, the following GET request can be issued:
GET {{pahost}}/api/{{tenant}}/v0/tm1/Servers?expand=*

See the following for more details on using the REST API: 
How to Connect to Planning Analytics as a Service Database using REST API with PA API Key

 

Document Location

Worldwide

[{"Type":"MASTER","Line of Business":{"code":"LOB76","label":"Data Platform"},"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SSEAI8G","label":"Planning Analytics as a Service"},"ARM Category":[{"code":"a8m3p000000GoaGAAS","label":"Planning Analytics-\u003EPlanning Analytics as a Service Specific"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"}]

Document Information

Modified date:
09 December 2025

UID

ibm17148410