CreatePlant - 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 Plant on a specified Site 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’)/CreatePlant

{

"catalogDatabaseName":"CatalogA",

"plantName":"PlantA",

"modelDatabaseServer":"ServerA",

"modelDatabaseName":"PlantA_MDB",

"reportsDatabaseServer":"ServerA",

"reportsDatabaseName":" PlantA_RDB",

"nameGeneratorServer": "NameGeneratorServerName",

"modelType": "Com.Ingr.S3dAdmin.V1.ModelType.Plant",

"modelPurpose": "Com.Ingr.S3dAdmin.V1.ModelPurpose.Standard"

}

Parameter

Type

Description

catalogDatabaseName

String

Name of the catalog database related to the plant being created

plantName

String

Name of the Plant to be created

modelDatabaseServer

String

The server name to create the plant database on

modelDatabaseName

String

Name of the model database to be used for this plant

reportsDatabaseServer

String

Server name to create the associated reports database on

reportsDatabaseName

String

Name of the reports database to be used for associated reports database for this plant

nameGeneratorServer

String

Name of the NameGenerator server to be used for this plant

modelType

Com.Ingr.S3dAdmin.V1.ModelType

Any value of the ModelType enum type

modelPurpose

Com.Ingr.S3dAdmin.V1.ModelPurpose

Any value of ModelPurpose enum type