Register plant - Intergraph Smart Engineering Manager - Help - Intergraph

Intergraph Smart Engineering Manager Smart API Help (Version 2)

PPMProduct
Intergraph Smart Engineering Manager
PPMCategory_custom
Help
Version_WebSEM
2.0

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

  • 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 the environment on which you create your Smart APIs.

Sample URI

POST

https://WebApiServer1.APIServerDomain.com/sem-webapi/sem/v2/Sites('WebAPISite_01')/Plants('WebAPIPlant_01')/Com.Ingr.Sem.v2.Register/

Sample JSON request

{

"plant":

{

"Id":"WebAPIPlant_01",

"HostName": "APIServer",

"WebDirectory": "spf2016server",

"SpfPlantName": "SPF2016",

"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/v2/$metadata#Com.Ingr.Sem.v2.RegisterResult",

"SpfPlantId": "PL_SPF2016",

"PlantName": "WebAPIPlant_01"

}