Create site - Intergraph Smart Engineering Manager - 3.0 - Customization & Programming - Hexagon

Intergraph Smart Engineering Manager Web API Help

Language
English
Product
Intergraph Smart Engineering Manager
Subproduct
Web API
Search by Category
Customization & Programming
Smart Engineering Manager Web Version
3.0

This request allows you to create a site in your database.

When you create a site using this request, the site is available for viewing using the 'Get site' request. Sites created using a Desktop version of the software, such as Smart Engineering Manager 11, or sites on which the Exclude site request was run, will not appear in the results of the 'Get site' request — to enable viewing of such sites, you must first run the Import site request.

Use the POST method to create a site with the following input:

  • Service Root URI: https://<Server Name>/<IIS Application Name>/sem/v3

  • Resource path: /Sites

Resource path strings are case-sensitive.

Sample URI

POST

https://WebApiServer1.APIServerDomain.com/sem-webapi/sem/v3/Sites

Sample JSON request

You specify the parameters for your new site in the body of the request.

  • Site names must be unique in the database.

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

  • Parameters and values shown in italics are specific to SQL Server or Oracle only. For details, see under 'Description and Comments' in the table below.

  • 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.

  • Oracle database passwords are not allowed to contain spaces or the following characters: ' $ @ "

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

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

{

"Name": "WebAPISite01",

"Description": null,

"IsCustomTemplate": false,

"CustomTemplatePath": null,

"SiteIniFileNamePath": "\\\\sem-sites\\WebAPI_Sites\\WebAPISite01",

"SiteBackupLocationPath": "\\\\sem-sites\\WebAPI_Sites\\WebAPISite01\\Backups",

"SiteRoleTemplateLocationPath": "\\\\sem-sites\\WebAPI_Sites\\WebAPISite01\\Roles",

"SiteAdminUserGroup": "Companydomain.com/SiteAdmin Users",

"SiteAdminAddUserGroupToEachPlant": true,

SQL Server parameters

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

"DataBaseType": "SQL Server",

"DatabaseServer": "SemserverMSS",

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

"DatabaseName": "WebAPISite01",

"SchemaUserName": "WebAPISite01","SchemaPassword": "WebAPISite01",

"DataDictUserName": "WebAPISite01d","DataDictPassword": "WebAPISite01d"

}

Oracle parameters

"DataBaseType": "Oracle",

"DatabaseServer": "SemserverORA",

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

"DatabaseName": "WebAPISite01",

"SchemaUserName": "WebAPISite01","SchemaPassword": "WebAPISite01",

"DataDictUserName": "WebAPISite01d","DataDictPassword": "WebAPISite01d",

"SchemaTablespace": "USERS","SchemaTempTablespace": "TEMP",

"DataDictTablespace": "USERS","DataDictTempTablespace": "TEMP"

}

JSON request parameters

Parameter

Value

Database Type

Description and Comments

Name

<Site Name>

Must have a unique value in the database

IsCustomTemplate

true / false

CustomTemplatePath

<path of custom template>

Only applies where "IsCustomTemplate" value is 'true'; otherwise, set value to 'null'

SiteINIFileNamePath

<path for site .ini file location>

SiteBackupLocationPath

<path for site backup file location>

SiteRoleTemplateLocationPath

<path for site role templates location>

SiteAdminUserGroup

<Domain Name/User Group>

SiteAdminUserGroupToEachPlant

true / false

DataBaseType

Oracle, SQL Server

DatabaseServer

<Server Name>

For SQL Server, can be the server on which the site .ini file is located, if required

SystemUser

For SQL Server, the case-sensitivity of this value depends on how the DBA defines it for the database

SystemPassword

DatabaseName

SQL Server

Database must be defined and available. Can have same name as site.

SchemaUserName

Can have same name as site

SchemaPassword

Can have same name as site

DataDictUserName

Can use name of site+'d'

DataDictPassword

Can use name of site+'d'

SchemaTablespace

USERS

Oracle

Value shown is default.

SchemaTempTablespace

TEMP

Oracle

Value shown is default.

DataDictTablespace

USERS

Oracle

Value shown is default.

DataDictTempTablespace

TEMP

Oracle

Value shown is default.

What do you want to do next?

Related topics

Update site

View sites

Delete site