Load plant sample JSON request (SQL Server) - Intergraph Smart Engineering Manager - 3.0 - Help - Hexagon PPM

Intergraph Smart Engineering Manager Web API Help

English (United States)
Intergraph Smart Engineering Manager
Search by Category
Smart Engineering Manager Web Version

  • Plant names must be unique in the database.

  • Backslashes used in paths must be doubled as shown below.

  • The example shown below is for a plant with two applications associated and where both applications are required in the copied plant. When loading a plant, ensure that applications not associated with the plant are excluded from the request.

  • Resource path strings are case-sensitive.

  • Database usernames are not allowed to contain spaces and the following characters: . < , > ? \ / ' ; { } [ ] ~ ` ! % * ( ) & $ @ # " - + ^ = | In addition, SQL Server database usernames are not allowed to begin with a number.

  • SQL Server database passwords are not allowed to contain spaces or the character: '

  • The database user names and passwords shown in the example are recommended values based on the name of your plant. For more information, see Assigning Database User Names.

A database with the DatbaseName value for the plant must be created manually before running the request.


"packagePath": "\\\\sem-sites\\WebAPI_Sites\\WebAPISite01\\Plants\\Backups\\Copy_of_WebAPIPlant01.zip",

"changeGuid": true,



"Id": "WebAPIPlant02",

"Name": "WebAPIPlant02",

"Description": "Description of plant",

"PlantStructurePath": "\\\\sem-sites\\WebAPI_Sites\\WebAPISite01\\Plants\\WebAPIPlant02",

"PlantBackupLocationPath": "\\\\sem-sites\\WebAPI_Sites\\WebAPISite01\\Plants\\Backups",

"DatabaseServer": "SemserverMSS",

"SystemUser": "<SysUser>","SystemPassword": "<Password>",

"DatabaseName": "WebAPIPlant02",

"SchemaUserName": "WebAPIPlant02","SchemaPassword": "WebAPIPlant02",

"DataDictUserName": "WebAPIPlant02d","DataDictPassword": "WebAPIPlant02d"





"ApplicationType": "Sppid",

"DatabaseName": "WebAPIPlant02",

"SchemaUserName": "WebAPIPlant02pid","SchemaPassword": "WebAPIPlant02pid",

"DataDictUserName": "WebAPIPlant02pidd","DataDictPassword": "WebAPIPlant02pidd",

"ReferenceDataPath": "\\\\sem-sites\\WebAPI_Sites\\WebAPISite01\\Reference Data\\P&ID Reference Data"



"ApplicationType": "Spel",

"DatabaseName": "WebAPIPlant02",

"SchemaUserName": "WebAPIPlant02el","SchemaPassword": "WebAPIPlant02el",

"DataDictUserName": "WebAPIPlant02eld","DataDictPassword": "WebAPIPlant02eld",

"RefSchemaUserName": "WebAPIPlant02elref","RefSchemaPassword": "WebAPIPlant02elref",

"ReferenceDataPath": "\\\\sem-sites\\WebAPI_Sites\\WebAPISite01\\Reference Data\\SEL Reference Data"




JSON request parameters



Description and Comments


Name and path of the .zip file for the plant to be loaded


true / false

A value of 'true' creates new identifiers when copying the plant. A value of 'false' retains the existing identifiers from the copied plant - this option is useful when working in an integrated environment when loading a plant with externally-modified data without the need to re-correlate the items when publishing for integration.


Section under which plant parameters are specified

Id / Name

<Plant Name>

The name the plant will have after loading. The Id and Name parameters must have the same value, and this value must be unique in the database.


Optional field

Type any text string or set value to 'null'


<path for plant structure location>


<path for plant backup file location>


Server name

Can be the server on which the site .ini file is located, if required


The case-sensitivity of this value depends on how the DBA defines it for the database



Can have same name as plant


Can have same name as plant


Can have same name as plant


Can use name of plant+'d'


Can use name of plant+'d'


Section under which application parameters are specified


Sppid (for Smart P&ID)

Spel (for Smart Electrical)

Specify the applications you want to include when loading the plant. Delete the section for each application you do not want to include.


Path to your application's reference data

For details of the rest of the application JSON request parameters, see the list of parameters and their values for the appropriate applications and database platform under Associate application.