HxGN SDx API Services - HxGN SDx - Update 63 - Administration & Configuration - Hexagon

This guide includes documentation for the latest update release. For more information about which features are available in each update, refer to the HxGN SDx Release Bulletin.

Not finding what you're looking for? We can help.

How do I find out which version of software I'm using?

HxGN SDx API Services provides access to your data within HxGN SDx. The configurable access is processed through an Application Programming Interface (API), which uses RESTful APIs that are provided in a standardized format using the Open Data Protocol (OData).

The Open Data Protocol (OData) is a data access protocol that provides a uniform way to structure data, query data, and manipulate data through create, read, update, and delete operations. To construct the OData syntax for your service calls or posts, Hexagon expects you to have experience using OData and a good understanding of your own metadata and the schema model being used. Examples shown reflect that they can be used in HxGN SDx.

The system administrator exposes the underlying data to the OData API by configuring an API Entry Point for each of the object class definitions or interface definitions as required. The system automatically configures any relationship definitions or edge definitions which are valid between the exposed types. These services provide full access control to the system data, as well as providing authorization using the OAuth standard.

The service calls shown in this document are only examples of the OData syntax that can be used to create a service call or POST. The object types in your system schema use different metadata for your own service calls or posts. To construct the OData syntax, you must have a good understanding of your own systems metadata and the schema model being used. The examples shown are examples only and show the short annotation version of the full URL. However, they can be modified for use in your instance of HxGN SDx.

• Users are expected to have a level of experience using OData, Web APIs, and managing their systems metadata.

• Information in this guide also applies to SmartPlant Foundation using Web API v1 or v2 to create OData requests. Web API v3 is not supported in SmartPlant Foundation.

Supply of API Services

API Services is supplied with the HxGN SDx software by default, and uses existing settings to set up access groups and column sets, and so on. Some settings and objects are shared by applications to reduce the administration overhead.

Customer Support
Hexagon Policy Against Software Piracy
Copyright 2016-2024, Hexagon AB and/or its subsidiaries and affiliates
Update 63
Published Monday, March 18, 2024 at 9:39 AM