API Tutorials

Below are simple tutorials to help you get started with using the Synthesis API. The tutorials assume some basic working knowledge in VBA or VB.NET programming, and general familiarity with the Synthesis Platform.

Using Object IDs
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 are helpful when learning how to use the API to read/write data to a repository.

To display the object ID in a Synthesis application, choose File > Application Setup, then click Other under the Synthesis Settings heading in the navigation panel. Select the check box for Display Object IDs. The object IDs will be displayed for the following items:

Tutorials
Before you begin, be sure to review the prerequisites presented in the overview page. The tutorials are designed to work with the latest version of the Synthesis Platform.

Basics

 * Connect or Disconnect from a Synthesis Repository
 * Add New Synthesis Resources to a Repository
 * Edit Existing Synthesis Resources
 * Calculate Results from a Model

Importing Data

 * Transfer Data to the Synthesis Data Warehouse (SDW)
 * Upload XML File to XFRACAS

Performing Analyses and Creating Plots (requires a Synthesis API license)

 * Perform Life Data Analysis
 * Perform Accelerated Life Testing Data Analysis
 * Perform Accelerated Life Testing Data Analysis with Stress Profiles
 * Create Plots

'' More tutorials coming soon... ''