This request allows you to register an existing plant with SmartPlant Foundation. To enable your plant to work in an integrated environment you need to set up and configure SmartPlant Foundation and SmartPlant integration.
Use the POST method to register a plant with the following input:
-
Service Root URI: https://<Server Name>/<IIS Application Name>/sem/v3
-
Resource path: /Sites('<Site Name>')/Plants('<Plant Name>')
-
You must send a separate request for each plant you want to register.
-
Resource path strings are case-sensitive.
-
The parameters for the service root URI below are provided as an example. The server and domain name you provide depend on your specific environment.
Sample URI
POST
https://WebApiServer1.APIServerDomain.com/sem-webapi/sem/v3/Sites('WebAPISite01')/Plants('WebAPIPlant01')/Com.Ingr.Sem.V2.Register/
Sample JSON request
{
"plant":
{
"Id":"WebAPIPlant01",
"HostName": "APIServer",
"WebDirectory": "spfserver",
"SpfPlantName": "SPFPLANT01",
"Username": "SEM_Service",
"Password": "",
"IsSecure": false
}
}
JSON request parameters
|
Parameter |
Value |
Description and Comments |
|---|---|---|
|
Id |
<Name of plant> |
Name of the plant to be registered |
|
HostName |
Node name used in SmartPlant Foundation URL |
|
|
WebDirectory |
Virtual directory name used in SmartPlant Foundation URL |
|
|
SpfPlantName |
<SmartPlant Foundation plant name> |
The SPF plant to be used to register your plant |
|
Username |
Name of user authorized to log in to SPF |
|
|
Password |
User password for login to SPF |
|
|
IsSecure |
true / false |
Set to 'false' for http SPF URL or 'true' for https SPF URL |
Sample JSON response
A typical response to the request is:
{
"@odata.context": "https://localhost/sem-webapi/sem/v3/$metadata#Com.Ingr.Sem.V2.RegisterResult",
"SpfPlantId": "PL_SPFPLANT01",
"PlantName": "WebAPIPlant01"
}