WorkPackages - Intergraph Smart Completions - Intergraph Smart Completions Update 24 - Customization & Programming

Create and update a work package, including all the information needed to manage the work package.

Supported HTTPS Methods: GET, PUT, PATCH, POST

Request URL:

<HOSTNAME>/sc/datalake/v1/Instances(2)/Projects(294)/WorkPackages

Header parameters:

Header Parameter	Description
Authorization	A token required for authenticating a request. The bearer token is a string, usually generated by the server in response to a login request. You must include this header in every request.
Content-Type	The request format or the original media type of the resource.

Header Parameter

Description

Authorization

A token required for authenticating a request.

The bearer token is a string, usually generated by the server in response to a login request.

You must include this header in every request.

Content-Type

The request format or the original media type of the resource.

Sample POST request payload:

{

"WPName": "API-WP-FT-0055",

"WPDescription": "Work Package Creation API POST method - FT",

"Cwp": "CWP-001",

"Ewp": "EWP-001",

"CompanyInstanceId": 2,

"WorkBreakdownUp1Id": 254,

"WorkBreakdownUp2Id": 250,

"WorkBreakdownUp3Id": 244,

"UsesProcessBreakdown": true,

"ProcessBreakdownId": null,

"ProcessBreakdownUp1Id": 110,

"ProcessBreakdownUp2Id": 82,

"ProcessBreakdownUp3Id": 1,

"Comment": "Some comments to check in WP - API",

"WorkPackageTypeId": 55,

"WPScheduledByID": 3,

"JobCategoryId": null,

"WPDisciplineId": 51,

"WPPriorityId": 50,

"SupplierCompanyId": 597,

"ResponsibleCompanyId": 596,

"WorkBreakdownId": null,

"ScheduleStartDate": "2023-08-02T00:00:00Z",

"ScheduleEndDate": "2023-08-30T00:00:00Z",

"ActualStartDate": "2023-08-01T00:00:00Z",

"PlanWTV": null,

"BudgetMH": 138.00,

"ActualWTV": null,

"ActualMH": null,

"EVMH": null,

"Field001": "API Custom 001",

"Field002": "API Custom 002",

"Field003": "API Custom 003",

"Field004": "API Custom 004",

"Field005": "API Custom 005",

"Field006": "API Custom 006",

"Field007": "API Custom 007",

"Field008": "API Custom 008",

"Field009": "API Custom 009",

"Field010": "API Custom 010"

}

Sample GET, PUT, or PATCH request payload:

{

"WPId": 1024,

"Comment": "Updating start date",

"ActualStartDate": "2023-09-15T00:00:00Z"

}

Request payload parameters:

Request Parameter	Data Type	Required, Optional, Recommended, or Unused	Description
WPName	String	GET - Optional PUT - Optional PATCH - Optional POST - Required	Unique name for the work package.
WPDescription	String	GET - Optional PUT - Optional PATCH - Optional POST - Required	Work package description.
WPId	Integer	GET - Required PUT - Required PATCH - Required POST - Unused	Unique ID of the work package in Smart Complections.
Cwp	String	GET - Optional PUT - Optional PATCH - Optional POST - Recommended	Construction work package (CWP) details.
Ewp	String	GET - Optional PUT - Optional PATCH - Optional POST - Recommended	Name of the engineering work package (EWP) that defines the work package being created or updated.
CompanyInstanceId	Integer	GET - Optional PUT - Optional PATCH - Optional POST - Required	Smart Completions ID for the instance that contains the project.
WorkBreakdownUp1Id	Integer	GET - Optional PUT - Optional PATCH - Optional POST - Optional or unused, as described in the Caution	Activity (tier 3) of the Work Breakdown Structure (WBS) during which the work package will be executed. Do not use this parameter unless the WBS is aligned between the scheduling and construction systems (for example, Ecosys and Smart Construction).
WorkBreakdownUp2Id	Integer	GET - Optional PUT - Optional PATCH - Optional POST - Optional or unused, as described in the Caution	Stage (tier 2) of the Work Breakdown Structure (WBS) during which the work package will be executed. Do not use this parameter unless the WBS is aligned between the scheduling and construction systems (for example, Ecosys and Smart Construction).
WorkBreakdownUp3Id	Integer	GET - Optional PUT - Optional PATCH - Optional POST - Required	Phase (tier 1) of the Work Breakdown Structure (WBS) during which the work package will be executed. Do not use this parameter unless the WBS is aligned between the scheduling and construction systems (for example, Ecosys and Smart Construction).
UsesProcessBreakdown	Boolean	GET - Optional PUT - Optional PATCH - Optional POST - Optional	Indicates whether the process is broken down by the PBS (true) or the LBS (false).
ProcessBreakdownId	Integer	GET - Optional PUT - Optional PATCH - Optional POST - Optional or unused, as described in the Caution	Subsystem (tier 4) of the Process Breakdown Structure (PBS) that the work package applies to. Do not use this parameter unless the PBS is aligned between the construction and information management systems (for example Smart Construction and HxGN SDx).
ProcessBreakdownUp1Id	Integer	GET - Optional PUT - Optional PATCH - Optional POST - Optional or unused, as described in the Caution	System (tier 3) of the Process Breakdown Structure (PBS) that the work package applies to. Do not use this parameter unless the PBS is aligned between the construction and information management systems (for example Smart Construction and HxGN SDx).
ProcessBreakdownUp2Id	Integer	GET - Optional PUT - Optional PATCH - Optional POST - Optional or unused, as described in the Caution	Process Area (tier 2) of the Process Breakdown Structure (PBS) that the work package applies to. Do not use this parameter unless the PBS is aligned between the construction and information management systems (for example Smart Construction and HxGN SDx).
ProcessBreakdownUp3Id	Integer	GET - Optional PUT - Optional PATCH - Optional POST - Optional or unused, as described in the Caution	Plant (tier 1) of the Process Breakdown Structure (PBS) that the work package applies to. Do not use this parameter unless the PBS is aligned between the construction and information management systems (for example Smart Construction and HxGN SDx).
Comment	String	GET - Optional PUT - Optional PATCH - Optional POST - Optional	Comments about the work package.
WorkPackageTypeId	Integer	GET - Optional PUT - Optional PATCH - Optional POST - Required	ID of the type of work package being created or updated. This helps with reporting.
WPScheduledByID	Integer	GET - Optional PUT - Optional PATCH - Optional POST - Optional	Resource ID for the person who scheduled the work package. Options are chosen from the Resource select list.
JobCategoryId	Integer	GET - Optional PUT - Optional PATCH - Optional POST - Recommended	The ID of the job category that will carry out the work package. This helps categorize work packages, which is useful for reporting and filtering. Options are chosen from the JobCategoryItem select list.
WPDisciplineId	Integer	GET - Optional PUT - Optional PATCH - Optional POST - Required	The ID of the work package discipline, for example mechanical, electrical, instrumentation, piping, or civil. Options are chosen from the DisciplineItem select list.
WPPriorityId	Integer	GET - Optional PUT - Optional PATCH - Optional POST - Optional	Priority ID options. Options are chosen from the WorkPackagePriority select list.
SupplierCompanyId	Integer	GET - Optional PUT - Optional PATCH - Optional POST - Optional	Supplier Company ID. Options are chosen from the SupplierCompany select list.
ResponsibleCompanyId	Integer	GET - Optional PUT - Optional PATCH - Optional POST - Optional	The ID of the company that will carry out the work package. This helps compile work packages for a specific company or contractor and allows CCMS tasks to be automatically assigned to the work package. Options are chosen from the WorkPackageResponsibleCompany select list.
WorkBreakdownId	Integer	GET - Optional PUT - Optional PATCH - Optional POST - Optional or unused, as described in the Caution	Project (tier 4) of the Work Breakdown Structure (WBS) during which the work package will be executed. Do not use this parameter unless the WBS is aligned between the scheduling and construction systems (for example, Ecosys and Smart Construction).
ScheduleStartDate	String (Date)	GET - Optional PUT - Optional PATCH - Optional POST - Required	Date on which the work is expected to start.
ScheduleEndDate	String (Date)	GET - Optional PUT - Optional PATCH - Optional POST - Required	Date on which the work is expected to end.
ActualStartDate	String (Date)	GET - Optional PUT - Optional PATCH - Optional POST - Optional	Date on which the work actually started.
PlanWTV	Number	GET - Optional PUT - Optional PATCH - Optional POST - Optional	Planned weighted value. Weighted value can be based on the budget person hours (BudgetMH) or the cost basis.
BudgetMH	Number (Currency)	GET - Optional PUT - Optional PATCH - Optional POST - Optional	Planned person hours for estimate plant item. Equivalent to the weighted value (WTV) for the cost basis. Person hours are also referred to as man hours (MH) in some systems.
ActualWTV	Number	GET - Optional PUT - Optional PATCH - Optional POST - Optional	Actual weighted value.
ActualMH	Number	GET - Optional PUT - Optional PATCH - Optional POST - Optional	Actual person hours for estimate plant item. Person hours are also referred to as man hours (MH) in some systems.
EVMH	Number	GET - Optional PUT - Optional PATCH - Optional POST - Optional	Earned value person hours for estimate plant item. Person hours are also referred to as man hours (MH) in some systems.
Field001 .. Field010	String	Dependent upon your company's implementation	Ten custom fields that can be used as defined by your company.

Sample response:

POST returns the newly-created record.
PATCH and PUT return the confirmation update status 204.

WorkPackages - Intergraph Smart Completions - Intergraph Smart Completions Update 24 - Customization & Programming - Hexagon

Intergraph Smart Completions Smart API Programmer's Reference Guide (5.3.24)