On a given site, restores an existing Plant as copied plant 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’)/RestorePlantAsCopy
{
"plantToRestore":"PlantA",
"newPlantName":"PlantACopy",
"catalogDatabaseName":"PlantA_CDB",
"modelDatabaseName": "PlantA_MDB",
"backupConfigurationFilePath": "\\\\fileshare\\DBBackups\\backup.bcf",
"backupFilesPath": "\\\\fileshare\\DBBackups\\",
"databaseServer": "ProductionServer1",
"sharedContentPath":"\\\\fileshare\\SharedContent",
"nameGeneratorServer": "ServerName",
"linkIfCatalogExist": true
}
|
Parameter |
Type |
Description |
|---|---|---|
|
plantToRestore |
String |
Name of the existing plant to be copied |
|
newPlantName |
String |
Name of the new Plant to be restored |
|
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 |
|
backupFilesPath |
String |
An accessible UNC path having the backup files |
|
databaseServer |
String |
The server name to restore the plant database to |
|
sharedContentPath |
String |
An accessible UNC path having symbol share |
|
nameGeneratorServer |
String |
Name of the NameGenerator server to be used for this plant |
|
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.