AssetProjects - 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 projects from assets.

Do not use this endpoint unless the Work Breakdown Structure (WBS) API has been used to align the WBS between the scheduling and construction systems (for example, Ecosys and Smart Construction).

Supported HTTPS Methods: GET, PUT, PATCH, POST

Request URL:

<HOSTNAME>/sc/datalake/v1/Instances(2)/AssetProjects

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 for assigning projects to assets:

{

"AssetId": 482253,

"WorkBreakdownUp3Id": 294

}

Sample request payload for removing projects from assets:

{

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

}

Request payload parameters:



Request Parameter



Data Type

Required, Optional,
Recommended, or
Unused



Description

AssetId

Integer

GET - Required

PUT - Required

PATCH - Required

POST - Required

Smart Completions ID assigned to the asset upon creation.

WorkBreakdownUp3Id

Integer

GET - Required

PUT - Required

PATCH - Required

POST - Required

Smart Completions ID for the Project (tier 1 of the Work Breakdown Structure) to assign to the asset.

dtRemoved

String (Date)

GET - Optional

PUT - Optional

PATCH - Optional

POST - Unused

Date on which the project was removed from the asset.

Sample response:

{

"@odata.context": "https://localhost:5001/DataLake/v1/$metadata#Instances(2)/AssetProjects/$entity",

"Id": 549161,

"AssetId": 482253,

"WorkBreakdownUp3Id": 294,

"AssetTag": "0.5\"-BS-3500-125-CSI423",

"Project": "STP01 - SONIC TEST PROJECT",

"Summary": "STP01 - SONIC TEST PROJECT",

"RecordCreated": "2023-11-14T05:14:43.59Z",

"RecordCreatedBy": null,

"RecordLastModified": null,

"RecordLastModifiedBy": null,

"dtRemoved": null,

"RecordRemovedBy": null

}

Response parameters:

Response Parameter

Data Type

Description

@odata.context

String

Request URL.

Id

Integer

Smart Completions ID assigned to the project upon linking to the asset.

AssetId

Integer

Smart Completions ID assigned to the asset upon creation.

WorkBreakdownUp3Id

Integer

Smart Completions ID for the Project (tier 1 of the Work Breakdown Structure) to assign to the asset.

AssetTag

String

Tag for the asset.

Project

String

Smart Completions name of the project that has been assigned to the asset.

Summary

String

Smart Completions description of the project that has been assigned to the asset.

RecordCreated

String (Date)

Read only. Date when the project was assigned to the asset in Smart Completions. Captured by Smart Completions.

RecordCreatedBy

String

Read only. Smart Completions name for the user who assigned the project to the asset in Smart Completions. Captured by Smart Completions.

RecordLastModified

String (date)

Read only. Date when the project assignment to an asset was last updated in Smart Completions. Captured by Smart Completions.

If the project assignment has not been updated since creation, this is the date the assignment was created.

RecordLastModifiedBy

String

Read only. Smart Completions name for the user who last updated the project assignment to an asset in Smart Completions. Captured by Smart Completions.

If the project assignment has not been updated since creation, this is the user who created the assignment.

dtRemoved

String (Date)

Read only. Date when the project was removed from an asset in Smart Completions. Captured by Smart Completions.

RecordRemovedBy

String

Read only. Smart Completions name for the user who removed the project assignment to the asset in Smart Completions. Captured by Smart Completions.