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

Backs up a given plant based on the given inputs. For example, the below URL backs up a Plant present on a Site entity using the details mentioned in the body.

POST

<ServiceRoot>/Sites(‘MySiteAlias’)/Plants(‘PlantA’)/BackupPlant

{

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

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

"overwriteExistingFile":true

}

Parameter

Type

Description

backupConfigurationFilePath

String

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

backupFilesPath

String

An accessible UNC path having the backup files

overwriteExistingFile

Boolean

Boolean indicating whether to overwrite if the files exist

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