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

This guide includes documentation for the latest update release. For information about the latest features available in each update, refer to the latest release notes.

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 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 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.

• You are expected to have a good level of knowledge and experience using OData, managing Web APIs, the schema model, API groups, and your systems metadata to construct the OData syntax.

• The service calls shown in this document are EXAMPLES of the OData syntax that can be used to create a service call or POST. Each example can be used as a template to construct service calls using the metadata from your SDx system, and use a short annotation of the full host URL address.

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

Supply of API Services

API Services is supplied with the 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-2025, Hexagon AB and/or its subsidiaries and affiliates
Update 70
Published Friday, February 28, 2025 at 2:17 PM