RestorePlantForSelectiveRecovery - 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 for selective recovery of model objects from the given inputs. For example, the below URL creates and returns a Plant entity using the details mentioned in the body.

POST

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

{

"plantToRestore":"PlantA",

"newPlantName ":"PlantSR",

"catalogDatabaseName":"PlantSR_CDB",

"modelDatabaseName": "PlantSR_MDB",

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

"backupFilesPath": "\\\\fileshare\\DBBackups\\",

"databaseServer": "ProductionServer1",

"linkIfCatalogExist": true

}

Parameter

Type

Description

plantToRestore

String

Plant name to restore the data from

newPlantName

String

Name of the new plant to be created

catalogDatabaseName

String

Name of the catalog database related to the plant being restored

modelDatabaseName

String

Name of the model database to be used for this plant

backupConfigurationFilePath

String

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

databaseServer

String

The server name to restore the site database to

backupFilesPath

String

An accessible UNC path having the backup files

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.