Add, Update, and Remove 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

Add Components to Installation Work Package

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

You can add one or more components to a installation work package (IWP) using the Web APIs.

POST {{url}}/SPCAddComponentsToInstallationWorkPackage

Content

{

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

ComponentIDs: "['XXXXXX', 'XXXXXX', 'XXXXXX']",

AutoAddDrawings: "[Boolean – True OR False]",

AddComponentValidationOptions:

{

IgnoreDisciplineMismatch: "[Boolean – True OR False]",

IgnoresNoAvailableSteps: "[Boolean – True OR False]",

IgnoreCWPMismatch: "[Boolean – True OR False]",

IgnoreComponentsComplete: "[Boolean – True OR False]",

IgnoreAll: "[Boolean – True OR False]"

}

}

Required information

  • Package ID of the IWP.

  • Component IDs that need to be added to the IWP.

  • Option stating if Drawings that have the components in them should get related to the IWP or not.

  • AddComponentValidationOptions class with the required properties and their values.

Notes

None

For example,

{

IWPID:"6GKO000A",

ComponentIDs: "['6GGF2GKA']",

AutoAddDrawings: "False",

AddComponentValidationOptions:

{

IgnoreDisciplineMismatch: "True",

IgnoresNoAvailableSteps: "True",

IgnoreCWPMismatch: "True",

IgnoreComponentsComplete: "True",

IgnoreAll: "True"

}

}

Update Components in Installation Work Package

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

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

POST {{url}}/SPCUpdateInstallationWorkPackageComponent

Content

{

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

"ComponentID": "[Component ID]",

"IWPComponentUpdateInfo":

{

"Sequence": "[Sequence Number]",

"IsComplete": "[Boolean – True OR False]"

}

}

Required information

  • Package ID of the IWP.

  • Component ID that need to be updated.

  • IWPComponentUpdateInfo class with the required properties and their values.

Notes

None

For example,

{

"IWPID": "6GKO000A",

"ComponentID": "6GGN6SLA",

"IWPComponentUpdateInfo":

{

"Sequence": "2",

"IsComplete": "True"

}

}

Remove Components from Installation Work Package

You can remove one or more components from an installation work package (IWP) using the Web APIs.

POST {{url}}/SPCRemoveAdhocComponentsFromInstallationWorkPackage

Content

{

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

ComponentIDs: "[‘XXXXX’,‘XXXXX’,‘XXXXX’]"

RemoveNonrelatedDrawing: "[Boolean – True or False]",

}

Required information

  • Package ID of the IWP.

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

  • Option stating if Drawings with Components no more related to the IWP should be removed or not.

Notes

None

For example,

{

IWPID: "6GKO000A",

ComponentIDs: "['6HSM000A']",

RemoveNonrelatedDrawing: "false"

}