This tutorial is targeting developers intending to integrate their applications with QVANTUM planning applications via the QVANTUM Public API. With completion of this tutorial, readers will be able to use the QVANTUM Public API to prepare a QVANTUM planning application, to update data and metadata of a planning application and to export data collected with a planning application in QVANTUM.
This tutorial is organized in the following topics:
- Getting a Tenant: request tenant
- Authentication: get access token
- Navigation: navigate in tenant, planning application, and cube
- Preparing Planning Applications: build model, upload data, build forms, invite a team
- Updating Planning Applications: update dimension structure definitions
- Exporting Planning Data: download planning data
For most relevant use cases, this tutorial documents the interaction with the QVANTUM Public API, using the wide-spread tool curl, thus allowing developers with access to a valid QVANTUM tenant context to follow along and prototype their integration. For each QVANTUM Public API call, this tutorial provides an executable curl command line and a description of the most relevant details of request and response payloads.
All examples in this tutorial are based on the same, close-to-minimal sample data set. The tutorial sample data set is available for download below.
The included subfolder
csv/metadata contains CSV files representing a valid planning model
definition. The subfolder
csv/data includes two CSV files containing valid cube cell data sets,
compliant with the sample planning model definition. The included subfolder
scripts includes a
set of simple bash scripts for the demonstration of typical tasks such as uploading a planning model,
uploading initial data, or downloading data.
The scripts included in this tutorial are exclusively designed for demonstrational purposes. They are not suited for productive use, as they omit important aspects such as error handling or proper handling of authentication information.
If you have questions, comments, etc. please email us at email@example.com.