Create a Web API - 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 (modified in an update).

  1. In the Dashboards feature set, select Create Web API.

  2. Select whether this is a local or remote Web API.

    SHARED Tip A Web API is already provided for connecting to your local server. This is HEX_Local_SDx_V2_DASH.

  3. Type a name and description for the Web API.

  4. Type the required URLs in the Base URL and Metadata URL fields.

    SHARED Tip You can use the environment variable {{LOCAL_SERVER_URL}} as part of the URL to connect to your local server. For example, the Base URL would be {{LOCAL_SERVER_URL}}api/v2/DASH/, where api/v2/DASH/ is the API entry point group specifically for dashboard requests.

  5. For a remote Web API, select the authorization server to use, and type the other authorization details required.

  6. If required, search for the request header to use with this Web API.