API Tutorials

<< Back to API Main Page

Below are simple tutorials to help you get started with using the Synthesis API. Before you begin:

• Be sure to complete all requirements described in the Getting Started section of the Synthesis API Reference page.

• Create a Synthesis repository for testing purposes. We recommend creating a new standard repository and saving it on your local drive when working with the tutorials. This will allow you to work and experiment with the examples unhindered by folder and database permissions.

• Display the object IDs in Synthesis applications. Each item in a Synthesis repository is identified by a unique record identifier called an object ID. Object IDs can help you trace responses from the API, which is helpful when you're just beginning to learn. We recommend reading this short topic on object IDs before you begin.

Finally, the tutorials assume some basic working knowledge in VBA or VB.NET programming, and general familiarity with the Synthesis Platform.

Tutorials

Basics

The following tutorials introduce you to the basic functionalities of the Synthesis API.

• Connect or Disconnect from a Synthesis Repository.

• Add New Synthesis Resources to a Repository.

• Edit Existing Synthesis Resources.

• Calculate Results from a Model.

Application Examples

• Transfer Data to the Synthesis Data Warehouse (SDW).

More tutorials coming soon...