Work Packages API usage guidance - Intergraph Smart Completions - Intergraph Smart Completions Update 24 - Customization & Programming - Hexagon

This topic provides guidance for common scenarios you might encounter when using the Work Packages API.

When to use the WorkPackages endpoint

A company can choose to create and manage work packages in an application other than Smart Completions, such as another construction management system or an information management solution such as HxGN SDx. When this happens, you can use the WorkPackages endpoint to add work packages to Smart Completions and keep them up-to-date when changes are made in the source application.

Basic work packages workflow

1. Use the WorkPackages endpoint to create the new work packages in Smart Completions.

2. Use the WorkPackagesSteps endpoint to:

   • Create work tasks and associate them to a work package.

   • Create volumetric work steps and associate them to a work package.

3. If you want to create work steps in Smart Completions from work tasks defined in a source (third-party) application:

   1. Use the WorkPackageTasks endpoint to create the tasks in Smart Completions.

   2. Use the CreateWorkStepsFromTasks action to create the work steps from the work tasks.

      The work steps are assigned to the work package.

4. Use other endpoints to create associations between work packages and other objects, as needed:

   • WorkPackageTasks

   • WorkPackagePunchlists

   • WorkPackagesDocuments

Associating work packages to WBS and PBS hierarchies

Most companies manage Work Breakdown Structure (WBS) and Construction Work Packages (CWPs) outside of Smart Completions. However, the Process Breakdown Structure (PBS) hierarchies are defined in Smart Completions.

The typical data structures and data are created and managed as follows:

• WBS is often managed in Ecosys.

• PBS is often managed in Smart Completions.

• CWPs and their associated work steps, and by extension the associated tags and inspection requirements, are often managed in Smart Plant Construction or Information Management (IM) systems like HxGN SDx.

When other applications are used to manage a hierarchy, you must be careful when creating or updating work packages. If the hierarchies are not aligned between the systems, you must omit the relevant parameters from your request payload. For specific information, see the request payload parameter descriptions in WorkPackages.