Publishing Object and Event APIs in EcoSys - EcoSys - Customization & Programming - Hexagon

EcoSys Web Service API Usage Documentation

Language
English
Product
EcoSys
Search by Category
Customization & Programming
EcoSys Version
8.6

Publish Object APIs

Object-based web service APIs can be published from EcoSys using the spreadsheet dictionary screen. You can define a spreadsheet for a desired subject area and view any columns you wish to access through the API.

To publish a spreadsheet definition as an API,

  1. Go to the required Spreadsheet.

  2. In the Options tab, enable the option for Publish for use through API.

  3. Assign a name to the API, which must be globally unique, and will be used by callers of the API.

  4. Check the options for Allow Read, Allow Update, Allow Insert, Allow Delete for the spreadsheet as per your requirement.

  5. Click Save.

Most of the edit rules available for spreadsheets are also available for configuration in an API, including the following:

  • Marking columns as read-only

  • Making columns not visible

  • Conditional formatting of rules to control edits on a per-row per-field basis.

Spreadsheets must be in list mode (not hierarchy mode), and grouping is not supported for published API views.

Publish Event APIs

Event-based web service APIs can be published from EcoSys using the Action batch and Report batch Dictionary screen. You can define an action batch and report batch to accept runtime parameters and then run the required actions and reports.

To publish an action batch and report batch as an API:

  1. Go to the required action batch or report batch

  2. Click the Options tab and enable the option for Publish for use through API.

    • For Report Batches, reports are created in the directory defined by the output location specified in the General tab of the report batch.

    • In the General tab, specify the report batch location in Output Location field and report format in Output Format field (for example, excel, CSV, PDF, RTF, and so on)

  3. Assign a name to the API, which must be globally unique, and will be used by callers of the API.

  4. Click Save and then click Run Batch.