Welcome

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.

Overview

This tutorial is organized in the following topics:

  1. Getting a Tenant: request tenant
  2. Authentication: get access token
  3. Navigation: navigate in tenant, planning application, and cube
  4. Preparing Planning Applications: build model, upload data, build forms, invite a team
  5. Updating Planning Applications: update dimension structure definitions
  6. Exporting Planning Data: download planning data

Tools

For each use case, 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.

Sample Data

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.

Download Tutorial Sample Data Set

The included subfolder csv/metadata contains CSV files representing a valid planning model definition, including individual dimension structure definitions and team definitions. 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 full sample bash scripts for the demonstration of typical tasks such as uploading a planning model, uploading initial data, or downloading data.

Feedback

If you have questions, comments, etc. please send email us at support@qvantum-plan.de. Our support team will get back to you ASAP personally.