Create site - Intergraph Smart Engineering Manager - Help - Intergraph

Intergraph Smart Engineering Manager Smart API Help (2.0)

PPMProduct
Intergraph Smart Engineering Manager
PPMCategory_custom
Help
Version_WebSEM
2.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 10.0 (2019), 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/v2

  • Resource path: /Sites

Resource path strings are case-sensitive.

Sample URI

POST

https://WebApiServer1.APIServerDomain.com/sem-webapi/sem/v2/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.

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

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

  • SQL Server database usernames cannot begin with a number, nor are they allowed to contain spaces and the following characters: " . < , > ? \ / ' ; { } [ ] ~ ` ! % * ( ) & $ @ #

  • SQL Server database passwords are not allowed to contain spaces and the following 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.

{

"@odata.context":"https://WebApiServer1.APIServerDomain.com/sem-webapi/sem/V2/Sites/$entity",

"@odata.type":"#Com.Ingr.Sem.V2.Site",

"IsCustomTemplate": false,

"CustomTemplatePath": null,

"Name": "WebAPISite01",

"Description": null,

"SiteIniFileNamePath": "\\\\VSORA12SEM\\AppOra12\\API_Sites\\WebAPISite01",

"SiteBackupLocationPath": "\\\\VSORA12SEM\\AppOra12\\API_Sites\\WebAPISite01\\Backups",

"SiteRoleTemplateLocationPath": "\\\\VSORA12SEM\\AppOra12\\API_Sites\\WebAPISite01\\Roles",

"SiteAdminUserGroup": "MyDomain.com/ALL-Domain-Users",

"SiteAdminAddUserGroupToEachPlant": true,

"DataBaseType": "Oracle",

"DatabaseServer": "SEM12DEV",

"SystemUser": "system","SystemPassword": "MyPassword01",

"DatabaseName": "WebAPISite01",

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

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

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

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

}

JSON request parameters

Parameter

Value

Description and Comments

@odata.context

"<HTTP request path>/$entity"

Required string when creating a site

@odata.type

"#Com.Ingr.Sem.V2.Site"

Required string when creating a site

IsCustomTemplate

true / false

CustomTemplatePath

<path of custom template>

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

Name

<Site Name>

Must have a unique value in the database

Description

Type any text string or 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

Parameter applies to SQL Server only. Can use name of site.

SchemaUserName

Can use name of site

SchemaPassword

Can use name of site

DataDictUserName

Can use name of site+'d'

DataDictPassword

Can use name of site+'d'

SchemaTablespace

USERS

Parameter applies to Oracle only. Value shown is default.

SchemaTempTablespace

TEMP

Parameter applies to Oracle only on site creation. Value shown is default.

DataDictTablespace

USERS

Parameter applies to Oracle only. Value shown is default.

DataDictTempTablespace

TEMP

Parameter applies to Oracle only on site creation. Value shown is default.

What do you want to do next?

Related topics

Update site

View sites

Delete site