Relyence User Guide
The Relyence API

The Relyence API

The Relyence API (Application Programming Interface) is an advanced way to insert, extract, and update data in your Relyence Analyses.

Note: Using the Relyence API is an advanced feature and should be utilized with care. Usage of the Relyence API requires a programming background.

The following functions are supported through the Relyence API:

General

  • Get a list of Analyses
  • Get information about which Relyence modules are active for an Analysis
  • Get a list of Subsystems in an Analysis
  • Get the Relyence URL of a record

FMEA

  • Get a list of FMEA Functions and all associated data from an Analysis. Includes data from all related Worksheets and can be optionally filtered by Subsystem.

FRACAS

  • Get a list of FRACAS Incidents from an Analysis
  • Insert, delete, and update FRACAS Incidents
  • Get a list of FRACAS Problems from an Analysis
  • Insert, delete, and update FRACAS Problems
  • Update a FRACAS custom list
  • Get FRACAS Calculation Results

Fault Tree

  • Get Fault Tree Calculation Results
Reliability Prediction
  • Get a list of Reliability Prediction Parts
  • Insert, delete, and update Reliability Prediction parts
  • Get Reliability Prediction Calculation Results

RBD

  • Get RBD Calculation Results

Weibull

  • Get a list of Weibull Data Sets

Using the Relyence API

The first step to begin using the Relyence API is to generate your unique Relyence API Key. See the Generating and Managing Your Relyence API Key topic for more information.

For detailed information on Postman and the Relyence API, see the Postman and the Relyence API section of this guide.

For detailed information on Relyence API functions, see the Relyence API Functions section of this guide.

For a sample code snippet, see the Relyence API Sample Code section of this guide.

Click here to view the Relyence API technical specification.