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

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

Language
English
Product
Intergraph Smart Completions
Search by Category
Customization & Programming
Smart Completions Version
5.3.24

Assign or remove a punchlist from a work package.

Supported HTTPS Methods: GET, PUT, PATCH, POST

Request URLs:

  • Assign a punchlist to a work package - <HOSTNAME>/sc/datalake/v1/Instances(2)/Projects(313)/WorkPackages(1024)/WorkPackagePunchlists

  • Remove a punchlist from a work package - <HOSTNAME>/sc/datalake/v1/Instances(2)/Projects(313)/Workpackages(1024)/WorkPackagePunchlists(9999)

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.

Sample request payload to add a punchlist to a work package:

{

"WPId": 1024,

"PunchlistId": 11077

}

Sample request payload to remove a task from a work package:

{

"dtRemoved": "2023-07-14T16:09:13-06:00"

}

Request payload parameters:



Request Parameter



Data Type

Required, Optional,
Recommended, or
Unused



Description

WPId

Integer

GET - Optional

PUT - Optional

PATCH - Optional

POST - Required

ID of the work package that the punchlist is being assigned to or removed from.

Options are chosen from the WorkPackageItem select list.

PunchlistId

Integer

GET - Required

PUT - Required

PATCH - Required

POST - Required

ID of the punchlist to assign to or remove from the work package.

Options are chosen from the PunchlistItem select list.

dtRemoved

Integer

GET - Optional

PUT - Optional

PATCH - Optional

POST - Unused

Date on which the punchlist was removed from the work package.

Response:

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