Documentation for the Planning Space Web API

External tools and third party applications can access Planning Space 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 Planning Space applications Dataflow, Economics, and Financials. The Web API is designed for the implementation of programmatic control and automation of Planning Space.

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

The API routes prefixed by '/data' are for access to the data stored in Planning Space 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 Planning Space Integration Services provide access to the data stored in a Planning Space 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 standarised query language.

Integration Services should be regarded as a subset of the Planning Space Web API, designed for data-oriented use cases, most typically where a client-server API connection is established between a data analysis client tool and a Planning Space 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. Some of the details of the OData API are explained in the section OData API ('/data') requests.

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

API Reference

See the section API Reference (Planning Space version: 20.3 Update 12 (20.3.12)) for full reference information for the individual APIs.