Documenting Published APIs - EcoSys - Customization & Programming - Hexagon PPM

EcoSys Web Service API Usage Documentation

Language
English (United States)
Product
EcoSys
Search by Category
Customization & Programming
EcoSys Version
9.0

Web services published from EcoSys will automatically provide documentation about their functionality and configuration. A web browser may be used to browse to the EcoSys URL and append "/api/" to view the list of published APIs.

For example,

http://prod.ecosys.com/ecosys/api/

For each published API, a specific generated documentation page includes:

  • API name

  • Description

  • Notes

  • Base object

  • Links to web service descriptors (generated WSDL, WADL, and XSD) and data access links

  • Definition of runtime parameters (data type, required indicator)

  • Definition of object attributes for object-based APIs (data type, access mode, allowable values, and source fields)

To configure APIs for advanced users, additional notes and documentation about the API and its attributes can be provided by entering text in the "Notes" and "Hint" sections of the Spreadsheet, Action Batch or Report Batch dictionary. These will be included in the generated documentation for the given API. The documentation view and service descriptors for a published API is generated live, so changes to the underlying definition will be reflected in the documentation page immediately when refreshed.