Key values for Postman used in this tutorial - Intergraph Smart Electrical - 2.1 - Help - Intergraph

Intergraph Smart Electrical Smart API Help

Language
English (United States)
Product
Intergraph Smart Electrical
Search by Category
Help
Smart Electrical Web Version
2.1

The following tables show the key values required to run the requests used in this tutorial.

Key for token in request header

Key value

Description

How to obtain it

Example

samServerUri

The SAM URI referenced in the Web API configuration file

Copy TokenIssuerUri value from response to 'Get Description' request

https://SAMServername.domain.com/

Keys for token in request Body

Key value

Description

How to obtain it

Example

samUserName

Your SAM username

From your SAM admin

HEXDEMO

samPassword

Your SAM password

From your SAM admin

Password.twenty21

samClientId

Your SAM client Id for the application you use (for example Postman)

From your SAM admin

DC228514-54B0-48FC-B930-C4AA51ED437D

samClientSecret

Your SAM client secret

From your SAM admin

Postman.2021

resourceID

Resource ID used to identify the scope for which the token is requested

Copy TokenAudience value from response to 'Get Description' request

acr_values

Optional parameter. Required only if the token is for an AD user.

From your SAM admin

NONE (clear the check box)

Keys for server, sites, and plants

Key value

Description

How to obtain it

Example

Token

The token required for all system requests

Run 'Get Token' request

The key value is populated automatically when the request is run

baseUri

The URI for the Web API machine

From your Web API admin

https://hexlive21-spel.hexagon.com

Version

The current Web API version

Current value is V2

V2

Application

The application name on IIS

From your Web API admin

WebApi

Product

The product abbreviation (SEL or SPID)

According to your product

SEL

SiteID

The site Id

From your Web API admin

SITE001

PlantID

The plant Id

From your Web API admin

PLANT001

ProjectID

The project Id, if existing

From your Web API admin

NONE

SelAreaName

Area name relevant to your ini file

From your Web API admin

Area02

Namespace Site

Site name for namespace
(usually the same as SiteID)

From your Web API admin

SITE001

Namespace Plant

Plant name for namespace
(usually the same as PlantID)

From your Web API admin

PLANT001