Object and Event Based APIs - EcoSys - Customization & Programming - Hexagon PPM

EcoSys Web Service API Usage Documentation

Search by Category
Customization & Programming
EcoSys Version

Two types of APIs are supported, objects and events.

  • Object APIs: Supports read and write of objects and their attributes, used for creating, reading, updating, and deleting objects (records). These correspond to spreadsheets in EcoSys, with objects mapping to spreadsheet rows.

  • Event APIs: Supports triggering an event, such as a work flow or data transformation. These correspond to action batches and report batches in EcoSys.

Both object and event-based APIs can be accessed through web services. They have slightly different inputs and outputs, described in the corresponding sections below.

The published web services provide different interfaces for callers, but internally are based on EcoSys engine that executes spreadsheets, action batches, report batches, and are subject to the same security and business logic.

Published API names must consist:

  • Only alphanumeric characters (A-Z, a-z, and 0-9),

  • Punctuation marks: "-" (hyphen), "_" (underscore), and "." (period).

  • API names must begin with a letter and cannot contain more than one contiguous ".".