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

Creates a Catalog on a specified Site based on given inputs. For example, the below URL creates and returns a Catalog entity using the details mentioned in the body.

POST

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

{

"databaseServer": "ProductionServer1",

"catalogDatabaseName":"PlantA_CDB",

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

"templateFilePath":"\\\\fileshare\\DBBackups\\CatalogDb.dat",

"overwriteExistingDatabase":"true"

}

Parameter

Type

Description

databaseServer

String

The server name to create the catalog database on

catalogDatabaseName

String

Name of the catalog database

sharedContentPath

String

An accessible UNC path having symbol share

templateFilePath

String

An accessible complete file path (UNC) of the catalog database template file

overwriteExistingDatabase

Boolean

Boolean indicating whether to overwrite if the databases exist

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