The following tables show the key values required to run the requests used in this tutorial.
Key for token in request header
|
Key variable |
Description |
How to obtain it |
Example value |
|
samServerUri |
The SAM URI referenced in the Web API configuration file |
Copy TokenIssuerUri value from response to 'Get Description' request, excluding 'sam/oauth' |
https://SAMServername.domain.com/ |
Keys for token in request body
|
Key variable |
Description |
How to obtain it |
Example value |
|
resourceID |
Use the variable name 'resourceID' to identify the scope value for which the token is requested |
Copy TokenAudience value from response to the 'Get Description' request. This value is generated in Smart API Manager during registration of Smart P&ID Web API. |
ABCED14-54B0-48FC-B930-C4AA51ED1195 |
|
samUserName |
Your SAM username |
Request from your SAM admin. Applies to a domain user with the needed permissions set in Smart API Manager. |
HEXDEMO |
|
samPassword |
Your SAM password |
Request from your SAM admin. Applies to a domain user with the needed permissions set in Smart API Manager. |
Password.twenty21 |
|
samClientId |
Your SAM client Id for the application you use (for example Postman) |
Request from your SAM admin. Generated during Smart Client registration within Smart API Manager. |
DC228514-54B0-48FC-B930-C4AA51ED437D |
|
samClientSecret |
Your SAM client secret |
Request from your SAM admin. Generated during Smart Client registration within Smart API Manager. |
Postman.2021 |
|
acr_values |
Optional parameter. Required only if the token is for an AD user. |
Request from your SAM admin. This value comes from the identity associated with the Client user under the API’s Authorized Groups and must be prefixed by the string idp. |
idp: 10AABBCC-1234-5678-9ABC-DEF123456789 |
Keys for server, sites, and plants
|
Key variable |
Description |
How to obtain it |
Example value |
|
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 |
Request from your Web API admin |
https://hexlive21-spel.hexagon.com |
|
Site |
The site Id |
Request from your Web API admin |
SITE001 |
|
Plant |
The plant Id |
Request from your Web API admin |
PLANT001 |