Smart Construction web APIs use the API Entry Points to expose the system objects, so that the objects they represent appear in the user interface when called.
The following table lists out the API Entry Points that are delivered.
Entity Type Name |
Description |
---|---|
CWA |
This refers to Construction Work Area |
CWP |
This refers to Construction Work Package |
IWP |
This refers to Installation Work Package |
Drawing |
This refers to the 2D drawings |
Component |
This refers to published and non-published components |
ComponentWorkTypeStep |
This refers to the work steps associated with the components |
Contract |
This refers to the contracts that are available in the system |
Contractor |
This refers to the contractors that are related to contracts and planning groups in the project configuration workbook |
SPCUser |
This refers to the Smart Construction users who can be associated with the following construction responsibilities:
|
Crew |
This refers to the crews created as objects in SmartPlant Foundation and that are available in the system |
PackageFolder |
This refers to the folders added to the Files Library |
PackageFile |
This refers to the files added to the Files Library |
PackageResource |
This refers to the resources that are required for construction. Examples of construction resources are permits required for work, crew size and duration, and equipment needed such as cranes or heavy-lifting equipment. Note: These resources are when added to IWPs, they become constraints associated with IWPs. |
PackageConstraint |
This refers to the required resources for activities that are added to IWPs as constraints. |
MaterialItem |
This refers to the material items that are available in the system. |
Area |
This refers to the area within a plant which is based on grouping of physical objects. |
SID |
Standard Installation Diagram/Detail. This refers to SIDs which may contain a drawing, fabrication instructions, installation instructions, and material details. SIDs detail the scope of work and method of fabrication and installation for a component and its support items, such as stands, connections, and so forth. |