Create, Update, and Delete operations for Components in Installation Work Packages - Intergraph Smart Construction - 8 - Customization & Programming - Hexagon PPM

Intergraph Smart Construction API and Programming Reference
Language
English
Product
Intergraph Smart Construction
Search by Category
Customization & Programming
Smart Construction Version
8

Create Components in Installation Work Packages

If you have configured rules of credit for this plant in this site, you cannot use this API to add manual components to installation work packages.

You can create component in installation work packages (IWP) along with their properties using the Web APIs.

POST {{url}}/SPCCreateManualComponentForInstallationWorkPackage

Content

{

"ID": "[Package ID of the IWP]",

"IWPManualComponentCreateInfo":

{

"Description": "[Description for the Component]",

"Sequence": "[Sequence Number]",

"DrawingID": "[Drawing ID]",

"Units": "[Unit Value]",

"Units_UOM": "[Unit of measurement for the Unit]"

}

}

Required information

  • Package ID for the IWP.

  • Name for the Component.

Notes

None

For example,

{

"ID": "6GKO000A",

"IWPManualComponentCreateInfo":

{

"Description": "Adhoc-01",

"Sequence": "5",

"DrawingId": "6GGX0GSA",

"Units": "12",

"Units_UOM": "m"

}

}

Update Components in Installation Work Packages

If you have configured rules of credit for this plant in this site, you cannot use this API to update manual components to installation work packages.

You can update some properties for the component in an installation work package (IWP) using the Web APIs.

POST {{url}}/SPCUpdateManualComponentForInstallationWorkPackage

Content

{

"IWPID":"[Package ID of the IWP]",

"ComponentID": "[Component ID of the Component]",

"IWPManualComponentUpdateInfo":

{

"Sequence": "[Sequence Number]",

"DrawingID": "[Drawing ID]",

"Units": "[Units Value]",

"Units_UOM": "[Unit of measurement for the Unit]",

"IsComplete": "[Status of the component as Boolean]"

}

}

Required information

  • Package ID for the IWP.

  • Component ID of the Component for which you are updating the properties.

  • IWPManualComponentUpdateInfo class with the required properties and their values.

Notes

None

For example,

{

"IWPID":"6GKO000A",

"ComponentID": "6HSE000A",

"IWPManualComponentUpdateInfo":

{

"Sequence": 20,

"DrawingId": "6GH20O5A",

"Units": 7,

"Units_UOM": "kg",

"IsComplete": "True"

}

}

Delete Components from Installation Work Packages

You can delete component from an installation work package (IWP) using the Web APIs.

POST {{url}}/SPCDeleteManualComponentForInstallationWorkPackage

Content

{

IWPID: "[Package ID of the IWP]",

ComponentIDs: "['XXXX', 'XXXX', 'XXXX']",

RemoveNonrelatedDrawing: "[Boolean]"

}

Required information

  • Package ID for the IWP.

  • Component IDs of the Components that need to be removed from the IWP.

  • Option stating if Drawings that have no components related to the IWP are to be removed or not.

Notes

None

For example,

{

IWPID: "6GKO000A",

ComponentIDs: "['6HSM000A']",

RemoveNonrelatedDrawing: "false"

}