Group API Entry Points - HxGN SDx - Update 63 - Administration & Configuration - Hexagon

HxGN SDx API Services Configuration

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

After you create an API Entry Point group, the separate endpoint is created with a unique OData metadata document. This OData metadata document only contains the configured API Entry Point types and API Server Procedures.

For example, if you create a new API Entry Point group named Custom, this creates a new OData end point with the same name Custom at the following locations:

api/v2/Custom/Plants

api/v2/Custom/Areas

api/v2/Custom/Units

Any API Entry Points or API Server Procedures that belong to the Custom API Entry Point Group appear in the OData metadata document at this new end point. Ungrouped API Entry Points appear in the metadata document at the root, such as /api/v2/.

Existing API Entry Point OData end points configured for API Services before Update 57 are unaffected by the new groupings. Those API Entry Points appear at their original locations. For example:

api/v1/Plants

api/v1/Areas

api/v1/Unit