Create a Web API to connect to your local SDx system - HxGN SDx - Update 63 - Administration & Configuration

Administration and Configuration of HxGN SDx

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

This functionality was modified in an update. For more information, see Create a Web API to connect to your local SDx system (modified in an update).

A Web API identifies a data source that we want to connect to. The data source can be local (your SDx system) or remote (an external system).

A Web API is provided to connect to your local SDx system. Our example uses this Web API to retrieve data from your SDx system and use it in a widget. You can also use it for any future widgets you create.

This section describes this delivered Web API. If you want to create a new one, you can follow the steps in Create a Web API.

  1. To find the delivered Web API, in the Dashboards feature set, select Web APIs. The Web API is called HEX_Local_SDx_V2_DASH.

  2. Click on the Web API to show its details.

Field

Value

Description

Name

HEX_Local_SDx_V2_DASH

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

Recommended for configuring dashboards - contains relevant entry points

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/DASH/

This identifies your local SDx system. Where:

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

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

Metadata URL

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

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

The next step is Create the dashboard and make it available to selected users.