CreateSite - Intergraph Smart 3D Web API - Customization & Programming - Hexagon PPM

Intergraph Smart 3D Admin Web API Programmers Reference

Language
English
Product
Intergraph Smart 3D Web API
Subproduct
Smart 3D Web APIs
Search by Category
Customization & Programming
Smart 3D Version
13

Creates a Site from the given inputs. For example, the below URL creates and returns a Site entity using the details mentioned in the body.

POST

<ServiceRoot>/CreateSite

{

"databaseServer": "ProductionServer1",

"databaseProvider": "Com.Ingr.S3dAdmin.V1.DatabaseProvider.MSSQL",

"siteDatabaseName": "SiteA_SDB",

"siteDatabaseWorkShareLocation": "LocationX",

"nameRuleIdentifier": "1",

"nameGeneratorServer": "ServerName",

"templateFilePath": "\\fileShare\\DB\\Backups\\AppRepos.dat",

"overwriteExistingDatabase": true,

"siteAlias": "MySiteAlias"

}

Parameter

Type

Description

databaseServer

string

The server name to create the site database on

databaseProvider

Com.Ingr.S3dAdmin.V1.DatabaseProvider

Any value of DatabaseProvider enum type

siteDatabaseName

String

Name of the database for the site being created

siteDatabaseWorkShareLocation

String

Name of the Location

nameRuleIdentifier

String

Name rule Identifier

nameGeneratorServer

String

Name of the NameGenerator server to be used for this site

templateFilePath

String

An accessible complete file path (UNC) of the site database template file

overwriteExistingDatabase

Boolean

Boolean indicating whether to overwrite if the databases exist

siteAlias

String

An alias to be used to refer this site

Make sure the UNC paths you specify have the required configuration. For help, see Required Configuration for File Paths.