Documentation for the PlanningSpace Web API

External tools and third party applications can access PlanningSpace data and functionality by means of several APIs.

Web API

This set of REST-based APIs allow access to the functionality and stored data of the PlanningSpace applications Dataflow, Economics, and Financials. The Web API is designed for the implementation of programmatic control and automation of PlanningSpace.

The API routes prefixed by '/api' offer control of PlanningSpace applications.

The API routes prefixed by '/data' are for access to the data stored in PlanningSpace applications, and the interface is based on the ISO/OASIS-standardized Open Data protocol (OData version 4: https://www.odata.org).

For more information, see the Web API section.

Integration Services (OData)

The PlanningSpace Integration Services provide access to the data stored in a PlanningSpace deployment for OData-compatible data analysis tools such as Power Query for Excel or Tibco Spotfire. OData is an API communication standard which provides a high degree of auto-discovery so that analysis tools can automatically inspect the data contents and formats available, and view and extract data using a standardized query language.

Integration Services should be regarded as a subset of the PlanningSpace Web API which is designed for data-oriented use cases. Most typically this will involve creating a client-server API connection between a data analysis client tool (which is compatible with the OData protocol) and a PlanningSpace server. At the API level, Integration Services consist of the '/data' API resources, which are accessed using OData-standard API queries with a special API authentication scheme that is designed to be compatible with what exists in most data analysis tools.

For more information, see the Integration Services (OData) section.

If you are trying to connect to PlanningSpace using an OData client tool, the place to look for quick help is the pages Using Excel Power Query as a client or Using Tibco Spotfire as a client.

Some of the details of the OData API are explained in the section OData API ('/data') requests.

API Reference

See the section API Reference (PlanningSpace version: 16.5 Update 33 (16.5.33)) for full reference information for the individual APIs.

Changes to the APIs that have been made in PlanningSpace 16.5 Update releases are listed in the API Change Logs page.