Create a Web API to connect to your local SDx system (modified in an update) - HxGN SDx - HxGN SDx - Reference - Hexagon

HxGN SDx Modified and Retired Functionality

Language
English
Product
HxGN SDx
Search by Category
Reference
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)

The following applies if you are using a version of the software before Update 36. For the latest information, see Create a Web API to connect to your local SDx system.

Before Update 36, the Web API provided for connecting to your local SDx server was called HEX_Local_SDx_V2. Its details are given below.

For systems upgraded to Update 36 or later, from an Update before Update 36, both the HEX_Local_SDx_V2 and HEX_Local_SDx_V2_DASH Web APIs are provided. It is recommended that you use HEX_Local_SDx_V2_DASH.

Field

Value

Description

Name

HEX_Local_SDx_V2

The name of the Web API. This is used to identify the Web API when selecting which Web API to use for a widget.

Description

Local SDx Web V2 API

A description of the Web API. This is used to identify the Web API when selecting which Web API to use for a widget.

Is Local?

(selected)

This is selected because the Web API connects to your local SDx system rather than an external data source.

Base URL

{{LOCAL_SERVER_URL}}api/v2/SDA/

This identifies your local SDx system. Where:

  • {{LOCAL_SERVER_URL}} is the environment variable pointing to your local SDx server.

  • api/v2/SDA is the SDA API entry point group.

Metadata URL

{{LOCAL_SERVER_URL}}api/v2/SDA/$metadata

This identifies how metadata is passed to the system. This is the same as the base URL with $metadata at the end.