RestoreSite - 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

Restores a site from the inputs provided. For example, the below URL restores a site from the backups and other inputs.

POST <ServiceRoot>/RestoreSite

{

"backupConfigurationFilePath": "\\\\fileShare\\DBBackups\\backup.bcf",

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

"databaseServer": "ProductionServer1",

"backupFilesPath": "\\\\fileShare\\DBBackups\\",

"siteDatabaseName": "SiteA_SDB",

"siteDatabaseWorkShareLocation": "Location",

"nameGeneratorServer": "ServerName",

"overwriteExistingDatabase": true,

"siteAlias": "MySiteAlias"

}

Parameter

Type

Description

databaseProvider

Com.Ingr.S3dAdmin.V1.DatabaseProvider

Any value of DatabaseProvider enum type

databaseServer

String

The server name to restore the site database to

backupFilesPath

String

An accessible UNC path having the backup files

siteDatabaseName

String

Name of the database for the site being restored

siteDatabaseWorkShareLocation

String

Name of the Location

nameGeneratorServer

String

Name of the NameGenerator server to be used for this site

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.

  • The UpToDate property in the response helps to understand if an upgrade is required. If the property UpToDate is set to false, an open property Status is also populated with the detailed information of current state of returned Plant entity.