Test an IBM Planning Analytics API request

Choose a TM1 REST API request, inspect its OData JSON, and highlight the Planning Analytics value that matters.

API JSON Playground

A small playground for Planning Analytics

This page extends the article with an IBM Planning Analytics oriented demo. Start from a TM1 REST API endpoint, read the JSON returned by the server, then point to a cube, cell, or dimension value.

The data below are fictional and are used only to explain the logic of a PA integration.

Planning Analytics API demo

Read a PA request like an exchange with the right counter

Click a use case, then click a business value. The full JSON stays visible and shows how an IBM Planning Analytics API exposes cubes, views, cellsets, cells, and dimensions.

TM1 REST endpoint

POST /api/v1/Cubes('plan_BudgetPlan')/Views('Budget input - Revenue')/tm1.Execute?$expand=Axes,Cells

Status

200 OK

JSON path

Requests to test

Bank counter analogy

At the counter, you do not ask for the whole bank: you name the right vault, the right file, and the expected level of detail.

MDX / PA equivalent

SELECT {[Version].[Actual], [Version].[Budget]} ON COLUMNS,
{[Month].[Jan-2026], [Month].[Feb-2026]} ON ROWS
FROM [plan_BudgetPlan]
WHERE ([Entity].[Belgium], [Account].[Revenue], [Currency].[Local], [Measure].[Amount]);

Reading the request

The URL targets a TM1 resource: cube, view, cellset, cell, or dimension.

The HTTP method states the intent: read, execute a view, or update a cell.

The status confirms whether Planning Analytics processed the request.

The OData JSON then returns axes, cells, attributes, and useful context.

PA values to inspect

JSON

/api/v1/Cubes('plan_BudgetPlan')/Views('Budget input - Revenue')/tm1.Execute?$expand=Axes,Cells

POST

Selected value

JSON path

Value

"cs_budget_input_01JQYB5R4P7X4F8W8M22N7B1"

Planning Analytics returns a cellset ID, which acts as the read ticket for the executed view.

Bank counter analogy

The counter gives you a case number to find this exact consultation again.

In PA, the ID lets you read, partition, or delete the cellset during the session.

What this demo shows

A Planning Analytics API exposes TM1 objects, not just a flat table.

The JSON path links a planning value to its exact location in the cellset or dimension.

The bank analogy still helps: you go to the right counter with the right identifiers, then receive a structured answer.

Back to the article Back to blog

Last updated on May 18, 2026