ProjectControlTasksAssets - 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 an asset from a project control task.

Supported HTTPS Methods: GET, PUT, PATCH, POST

Request URLs:

  • Assign an asset to a project control task - <HOSTNAME>/sc/datalake/v1/Instances(2)/
    Projects(294)/ProjectControlTaskss(242596)/ProjectControlTasksAssets

  • Remove an asset from a project control task - <HOSTNAME>/sc/datalake/v1/Instances(2)/Projects(294)/
    ProjectControlTaskss(242596)/ProjectControlTasksAssets(11906)

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 an asset to a project control task (POST only):

{

"ProjectControlTaskId": 242597,

"AssetId": 11906

}

Sample request payload to remove an asset from a project control task (PUT or PATCH only):

{

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

}

Request payload parameters:



Request Parameter



Data Type

Required, Optional,
Recommended, or
Unused



Description

ProjectControlTaskId

Integer

GET - Required

PUT - Required

PATCH - Required

POST - Required

Smart Completions ID for the project control task that the asset is being assigned to or removed from.

AssetId

Integer

GET - Required

PUT - Required

PATCH - Required

POST - Required

Smart Completions ID for the asset to assign to or remove from the project control task.

dtRemoved

String (Date)

GET - Optional

PUT - Optional

PATCH - Optional

POST - Unused

Date on which the asset was removed from the project control task.

Sample response:

{

"@odata.context":"https://sc-master.intergraph.com/SC/DataLake/v1/

$metadata#Instances(2)/Projects(294)/ProjectControlTaskss(242597)/

ProjectControlTasksAssets/$entity",

"Id": 2,

"ProjectControlTaskId": 242597,

"AssetId": 11906,

"RecordCreated": "2023-11-06T11:33:48.467Z",

"RecordCreatedBy": "Sai Sai",

"RecordCreatedById": 1039,

"RecordLastModified": null,

"RecordLastModifiedBy": null,

"RecordLastModifiedById": null,

"dtRemoved": null,

"RecordRemovedBy": null,

"RecordRemovedById": null

}

Response parameters:


Response Parameter


Data Type


Description

@odata.context

String

Request URL.

Id

Integer

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

ProjectControlTaskId

Integer

Smart Completions ID of the project control task that the asset is being assigned to or removed from.

AssetId

Integer

Smart completions ID for the asset to assign to or remove from the project control task.

RecordCreated

String (Date)

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

RecordCreatedBy

String

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

RecordCreatedById

Integer

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

RecordLastModified

String (Date)

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

If the 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 changed which project control task the asset was associated with in Smart Completions. Captured by Smart Completions.

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

RecordLastModifiedById

Integer

Read only. Smart Completions ID of the user who last changed which project control task the asset was associated to in Smart Completions. Captured by Smart Completions.

dtRemoved

String (Date)

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

RecordRemovedBy

String

Read only. Smart Completions user who removed the asset assignment to a project control task in Smart Completions. Captured by Smart Completions.

RecordRemovedById

Integer

Read only. User ID of the Smart Completions user who removed the asset assignment to a project control task in Smart Completions. Captured by Smart Completions.