Create plant group - Intergraph Smart Engineering Manager - Help - Intergraph

Intergraph Smart Engineering Manager Smart API Help (Version 2)

PPMProduct
Intergraph Smart Engineering Manager
PPMCategory_custom
Help
Version_WebSEM
2.0

This request allows you to add a plant group to your site.

Use the POST method to create a plant group with the following input:

  • Service Root URI: https://<Server Name>/<IIS Application Name>/sem/v2

  • Resource path: /Sites('<Site Name>')/Plants('<Plant Name>')/PlantGroups

  • Resource path strings are case-sensitive.

  • The parameters for the service root URI below are provided as an example. The server and domain name you provide depend on the environment on which you create your Smart APIs.

Sample URI

POST

https://WebApiServer1.APIServerDomain.com/sem-webapi/sem/v2/Sites('WebAPISite_01')/Plants('WebAPIPlant_01')/PlantGroups

Sample JSON requests

The following requests apply to a plant hierarchy where the highest level plant group type is the plant, for example:

Create a plant group at the highest intermediate level

{

"Name": "PG1",

"Description": "Plant Group 1"

"ParentID": ""

}

Create an intermediate-level plant group

{

"Name": "PG2",

"Description": "Plant Group 2"

"ParentID": "3FA2231501B446588C05F69EA3DCC710"

}

Create a plant group of type 'Unit' at any level

{

"Name": "PG3",

"Description": "Unit 1"

"ParentID": "F09D008AD08C47E3A13401368F4079B5"

"UnitCode" = "Unit 1"

}

  • Plant group names at each level must be unique.

  • When creating a plant group of type 'Unit', the 'UnitCode' parameter is mandatory, regardless of the unit's level in the hierarchy.

  • When creating a plant group of type 'Site', an optional string parameter, 'Address' may be added.

  • The plant group type of the new plant group is determined according to the plant hierarchy of the plant and the plant group's parent ID; for example, if the plant hierarchy is Plant-Area-Unit:

    • A new plant group created with a blank parent ID will be of plant group type = Area.

    • A new plant group created with a parent ID corresponding to an Area will be of plant group type = Unit.

What do you want to do next?

Related topics

View plant groups

Delete plant group