RestorePlant - 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 Plant on a specified Site from the given inputs. For example, the below URL restores and returns a Plant entity using the details mentioned in the body.

POST

<ServiceRoot>/Sites(‘MySiteAlias’)/RestorePlant

{

"plantName":"PlantA",

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

"databaseServer": "ProductionServer1",

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

"sharedContentPath":"\\\\fileshare\\SharedContent",

"nameGeneratorServer": "ServerName",

"overwriteExistingDatabase": true,

"linkIfCatalogExist": false

}

Parameter

Type

Description

plantName

String

Name of the Plant to be restored

backupConfigurationFilePath

String

An accessible complete file path (UNC) of the bcf file

databaseServer

String

The server name to restore the plant database to

backupFilesPath

String

An accessible UNC path having the backup files

sharedContentPath

String

An accessible UNC path having symbol share

nameGeneratorServer

String

Name of the NameGenerator server to be used for this plant

overwriteExistingDatabase

Boolean

Boolean indicating whether to overwrite if the databases exist

linkIfCatalogExist

Boolean

Boolean indicating whether to link to the existing catalog if exists

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