Create, update, or remove assets.
Supported HTTPS Methods: GET, PUT, PATCH, POST
Request URL:
<HOSTNAME>/sc/datalake/v1/Instances(2)/Assets
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 creating or updating assets:
{
"AssetTag": "0.5\"-BS-3500-125-CSI423",
"AssetDescription": "Barren solution",
"Service": "1",
"WorkScope": "sa",
"TechSpec": "sadsad",
"VendorPartNumber": "asas",
"Comments": null,
"Latitude": 17.3198122,
"Longitude": 78.4761156,
"Altitude": 491.199981689453,
"InstrumentLineNumID": null,
"IsDocVerified": true,
"IsFieldVerified": true,
"ImageID": 37068,
"Image2ID": 37069,
"AssetTypeId": 37333,
"AssetDisciplineId": 518,
"AssetStatusId": 19,
"AssetPriorityId": 238,
"PhysicalLocationId": 417,
"PhysicalLocationUp1Id": 416,
"PhysicalLocationUp2Id": 415,
"PhysicalLocationUp3Id": 414,
"ProcessBreakdownId": 1522,
"ProcessBreakdownUp1Id": 1521,
"ProcessBreakdownUp2Id": 1512,
"ProcessBreakdownUp3Id": 16377,
"ElectricalSourceElectricalRoom": "Yes",
"ElectricalSourceMCCNumber": "Yes",
"ElectricalSourceMCCCubical": "Yes",
"SAPFunctionalLocation": "test android qa 1",
"SAPMaterialCode": "test",
"ListPrice": 21.0000,
"PurchaseOrder": "12",
"PurchaseDate": "2023-08-01T05:30:00Z",
}
Sample request payload for removing assets:
{
"dtRemoved": "2023-07-14T16:09:13-06:00"
}
Request payload parameters:
For more help with asset parameters, see Asset Types.
|
|
|
Required, Optional, |
|
|---|---|---|---|
|
AssetTag |
String |
GET - Optional PUT - Optional PATCH - Optional POST - Required |
Tag for the asset. |
|
AssetDescription |
String |
GET - Optional PUT - Optional PATCH - Optional POST - Required |
Description of the asset. |
|
Service |
String |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Service of the asset, typically identifying what part of the process, or parent equipment it is operating within. |
|
WorkScope |
String |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Work scope of the asset. If needed, defined outside of Smart Completions and imported as part of an asset tag registry. |
|
TechSpec |
String |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Technical specification of the asset. If needed, defined outside of Smart Completions and imported as part of an asset tag registry. |
|
VendorPartNumber |
String |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Vendor part number. |
|
Comments |
String |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Comments about the asset. |
|
Latitude |
Decimal |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
GPS latitude value for asset. |
|
Longitude |
Decimal |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
GPS longitude value for asset. |
|
Altitude |
Decimal |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
GPS altitude value for asset. |
|
InstrumentLineNumID |
String |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
ID of the piping/line number an instrument is associated (resides on). |
|
IsDocVerified |
Boolean |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Indicates whether the asset/tag is verified on a controlled document (True) or not (False). |
|
IsFieldVerified |
Boolean |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Indicates whether the asset/tag is verified in the field (True) or not (False).
|
|
ImageID |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Smart Completions ID of the image uploaded for asset. |
|
Image2ID |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Smart Completions ID of the image uploaded for asset. |
|
AssetTypeId |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Required |
Smart Completions ID for the tag type of the asset. Smart Completions uses the asset type to determine what Inspection Test Plan (ITP) to assign to the asset. |
|
AssetDisciplineId |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Required |
Smart Completions ID for the discipline to which the tag type belongs, for example Mechanical, Electrical, Instrumentation, Piping, or Civil. Smart Completions uses the discipline to determine what schema to align a tag to. |
|
AssetStatusId |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Smart Completions ID for the status of the asset. |
|
AssetPriorityId |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Smart Completions ID for the priority of the asset. |
|
PhysicalLocationId |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Optional or unused, as described in the Caution |
Smart Completions ID for the Physical Location (tier 4 of the Location Breakdown Structure) that the asset is assigned to.
|
|
PhysicalLocationUp1Id |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Optional or unused, as described in the Caution |
Smart Completions ID for the Area (tier 3 of the Location Breakdown Structure) that the asset is assigned to.
|
|
PhysicalLocationUp2Id |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Optional or unused, as described in the Caution |
Smart Completions ID for the Process Area (tier 2 of the Location Breakdown Structure) that the asset is assigned to.
|
|
PhysicalLocationUp3Id |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Optional or unused, as described in the Caution |
Smart Completions ID for the Plant (tier 1 of the Location Breakdown Structure) that the asset is assigned to.
|
|
ProcessBreakdownId |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Optional or unused, as described in the Caution |
Smart Completions ID for the Subsystem (tier 4 of the Process Breakdown Structure) that the asset is assigned to.
|
|
ProcessBreakdownUp1Id |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Optional or unused, as described in the Caution |
Smart Completions ID for the System (tier 3 of the Process Breakdown Structure) that the asset is assigned to.
|
|
ProcessBreakdownUp2Id |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Optional or unused, as described in the Caution |
Smart Completions ID for the Process Area (tier 2 of the Process Breakdown Structure) that the asset is assigned to.
|
|
ProcessBreakdownUp3Id |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Optional or unused, as described in the Caution |
Smart Completions ID for the Plant (tier 1 of the Process Breakdown Structure) that the asset is assigned to.
|
|
ElectricalSourceElectricalRoom |
String |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Electrical Room, part of the asset energization location. |
|
ElectricalSourceMCCNumber |
String |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Motor Control Center (MCC), part of the asset energization location. |
|
ElectricalSourceMCCCubical |
String |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Motor Control Center (MCC) cubical, part of the asset energization location. |
|
SAPFunctionalLocation |
String |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Equivalent reference tag from the asset maintenance systems (AMS), for example SAP, or Maximo. |
|
SAPMaterialCode |
String |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Material reference code typically from the asset maintenance systems (AMS), for example SAP or Maximo. |
|
ListPrice |
Decimal |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Cost of the asset, as stated by the vendor. |
|
PurchaseOrder |
String |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Purchase order for the asset. |
|
PurchaseDate |
String (Date) |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Date on which the asset was purchased. |
|
dtRemoved |
String (Date) |
GET - Optional PUT - Optional PATCH - Optional POST - Unused |
Date on which the asset was removed. |
Do not use this parameter unless the Sample response:
{
"@odata.context": "https://localhost:5001/DataLake/v1/
$metadata#Instances(2)/Assets/$entity",
"Id": 482253,
"AssetId": 482253,
"AssetTag": "0.5\"-BS-3500-125-CSI423",
"AssetDescription": "Barren solution",
"Service": "1",
"AssetSummary": "0.5\"-BS-3500-125-CSI423 - Barren solution",
"WorkScope": "sa",
"TechSpec": "sadsad",
"VendorPartNumber": "asas",
"ExternalLink": null,
"DataSourceId": null,
"Comments": null,
"Latitude": 17.3198122,
"Longitude": 78.4761156,
"Altitude": 491.199981689453,
"ParentID": null,
"Parent": null,
"InstrumentLineNumID": null,
"InstrumentLineNum": null,
"IsDocVerified": true,
"IsFieldVerified": true,
"ImageID": 37068,
"Image2ID": 37069,
"AssetTypeId": 37333,
"AssetType": "AAH",
"AssetTypeSummary": "AAH - Analyzing Alarm High 2",
"AssetDisciplineId": 518,
"AssetDiscipline": "MECH",
"AssetStatusId": 19,
"AssetStatus": "Construction",
"AssetPriorityId": 238,
"AssetPriority": "Highest",
"PhysicalLocationId": 417,
"PhysicalLocationUp1Id": 416,
"PhysicalLocationUp2Id": 415,
"PhysicalLocationUp3Id": 414,
"PhysicalLocation": "10-10-1-1 - Location 1",
"PhysicalLocationUp1Summary": "10-10-1 - Area 1",
"PhysicalLocationUp2Summary": "10-10 - Facility 1",
"PhysicalLocationUp3Summary": "10 - Plant",
"ProcessBreakdownId": 1522,
"ProcessBreakdownUp1Id": 1521,
"ProcessBreakdownUp2Id": 1512,
"ProcessBreakdownUp3Id": 16377,
"ProcessBreakdown": "1100-124-08-01 - DANGEROUS GOODS SHELTER BUILDING
SERVICES [3340-A-4007]",
"ProcessBreakdownUp1Summary": "1100-124-08 - WASTE MANAGEMENT SHELTER BUILDING
SERVICES [3340-A-4008]",
"ProcessBreakdownUp2Summary": "1100-124 - BUILDINGS",
"ProcessBreakdownUp3Summary": "1000 - TRAIN 1",
"ControlSystemBreakdownId": null,
"ControlSystemBreakdownUp1Id": null,
"ControlSystemBreakdownUp2Id": null,
"ControlSystemBreakdownUp3Id": null,
"ControlSystemBreakdown": null,
"ControlSystemBreakdownUp1Summary": null,
"ControlSystemBreakdownUp2Summary": null,
"ControlSystemBreakdownUp3Summary": null,
"ElectricalSourceElectricalRoom": "Yes",
"ElectricalSourceMCCNumber": "Yes",
"ElectricalSourceMCCCubical": "Yes",
"SAPFunctionalLocation": "test android qa 1",
"SAPMaterialCode": "test",
"ListPrice": 21.0000,
"PurchaseOrder": "12",
"PurchaseDate": "2023-08-01T05:30:00Z",
"VendorId": null,
"Vendor": null,
"RecordCreated": "2023-11-14T05:06:40.413Z",
"RecordCreatedBy": "Sai, Sai",
"RecordCreatedById": 1039,
"RecordLastModified": "2023-11-14T05:14:43.587Z",
"RecordLastModifiedBy": null,
"RecordLastModifiedById": null,
"dtRemoved": null,
"RecordRemovedBy": null,
"RecordRemovedById": null,
"WorkBreakdownUp3Id": 294,
"CompanyInstanceId": 2
}
Response parameters:
|
Response Parameter |
Data Type |
Description |
|
@odata.context |
String |
Request URL. |
|
ID |
Integer |
ID assigned by Smart Completions upon creation of an asset. |
|
AssetId |
Integer |
Smart Completions ID assigned to the asset upon creation. |
|
AssetTag |
String |
Tag for the asset. |
|
AssetDescription |
String |
Description of the asset. |
|
Service |
String |
Service of the asset, typically identifying what part of the process or parent equipment it is operating within. |
|
AssetSummary |
String |
Combination of the Smart Completions name and description for the asset. |
|
WorkScope |
String |
Work scope of the asset. If needed, defined outside of Smart Completions and imported as part of an asset tag registry. |
|
TechSpec |
String |
Technical specification for asset. If needed, defined outside of Smart Completions and imported as part of an asset tag registry. |
|
VendorPartNumber |
String |
Vendor part number for asset. |
|
ExternalLink |
String |
URL to external system for same record. |
|
DataSourceId |
Integer |
ID of the application that the asset came from, for example HxGN SDx or Aconex. |
|
Comments |
String |
Comments about the asset. |
|
Latitude |
Decimal |
GPS latitude value for asset. |
|
Longitude |
Decimal |
GPS longitude Value for asset. |
|
Altitude |
Decimal |
GPS altitude value for asset. |
|
ParentId |
Integer |
Smart Completions ID for the parent asset of the selected asset. |
|
Parent |
String |
Smart Completions name for the parent asset of the selected asset. |
|
InstrumentLineNumID |
Integer |
ID of the piping/line number an instrument is associated with (resides on). |
|
InstrumentLineNum |
String |
Name of the piping/line number an instrument is associated with (resides on). |
|
IsDocVerified |
Boolean |
Indicates whether the asset/tag is verified on a controlled document (True) or not (False). |
|
IsFieldVerified |
Boolean |
Indicates whether the asset/tag is verified in the field (True) or not (False).
|
|
ImageID |
Integer |
Smart Completions ID of the image uploaded for the asset. |
|
Image2ID |
Integer |
Smart Completions ID of the image uploaded for the asset. |
|
AssetTypeId |
Integer |
Smart Completions uses the asset type to determine what Inspection Test Plan (ITP) to assign to the asset. |
|
AssetType |
String |
Smart Completions name for the tag type of the asset. |
|
AssetTypeSummary |
String |
Smart Completions summary for the tag type of the asset. |
|
AssetDisciplineId |
Integer |
Smart Completions ID for the discipline to which the tag type belongs, for example Mechanical, Electrical, Instrumentation, Piping, or Civil. Smart Completions uses the discipline to determine what schema to align a tag to. |
|
AssetDiscipline |
String |
Smart Completions name for the discipline to which the tag type belongs, for example Mechanical, Electrical, Instrumentation, Piping, or Civil. |
|
AssetStatusId |
Integer |
Smart Completions ID for the status of the asset. |
|
AssetStatus |
String |
Smart Completions status of the asset. |
|
AssetPriorityId |
Integer |
Smart Completions ID for the priority of the asset. |
|
AssetPriority |
String |
Smart Completions name for the status of the asset. |
|
PhysicalLocationId |
Integer |
Smart Completions ID for the Physical Location (tier 4 of the Location Breakdown Structure) that the asset is assigned to. |
|
PhysicalLocationUp1Id |
Integer |
Smart Completions ID for the Area (tier 3 of the Location Breakdown Structure) that the asset is assigned to. |
|
PhysicalLocationUp2Id |
Integer |
Smart Completions ID for the Process Area (tier 2 of the Location Breakdown Structure) that the asset is assigned to. |
|
PhysicalLocationUp3Id |
Integer |
Smart Completions ID for the Plant (tier 1 of the Location Breakdown Structure) that the asset is assigned to. |
|
PhysicalLocation |
String |
Smart Completions summary for the Physical Location (tier 4 of the Location Breakdown Structure) that the asset is assigned to. |
|
PhysicalLocationUp1Summary |
String |
Smart Completions summary for the Area (tier 3 of the Location Breakdown Structure) that the asset is assigned to. |
|
PhysicalLocationUp2Summary |
String |
Smart Completions summary for the Process Area (tier 2 of the Location Breakdown Structure) that the asset is assigned to. |
|
PhysicalLocationUp3Summary |
String |
Smart Completions summary for the Plant (tier 1 of the Location Breakdown Structure) that the asset is assigned to. |
|
ProcessBreakdownId |
Integer |
Smart Completions ID for the Subsystem (tier 4 of the Process Breakdown Structure) that the asset is assigned to. |
|
ProcessBreakdownUp1Id |
Integer |
Smart Completions ID for the System (tier 3 of the Process Breakdown Structure) that the asset is assigned to. |
|
ProcessBreakdownUp2Id |
Integer |
Smart Completions ID for the Process Area (tier 2 of the Process Breakdown Structure) that the asset is assigned to. |
|
ProcessBreakdownUp3Id |
Integer |
Smart Completions ID for the Plant (tier 1 of the Process Breakdown Structure) that the asset is assigned to. |
|
ProcessBreakdown |
String |
Smart Completions summary for the Subsystem (tier 4 of the Process Breakdown Structure) that the asset is assigned to. |
|
ProcessBreakdownUp1Summary |
String |
Smart Completions summary for the System (tier 3 of the Process Breakdown Structure) that the asset is assigned to. |
|
ProcessBreakdownUp2Summary |
String |
Smart Completions summary for the Process Area (tier 2 of the Process Breakdown Structure) that the asset is assigned to. |
|
ProcessBreakdownUp3Summary |
String |
Smart Completions summary for the Plant (tier 1 of the Process Breakdown Structure) that the asset is assigned to. |
|
ControlSystemBreakdownId |
Integer |
ID of level 4 (bottom node) of the user-defined Control System tree. |
|
ControlSystemBreakdownUp1Id |
Integer |
ID of level 3 of the user-defined Control System tree. |
|
ControlSystemBreakdownUp2Id |
Integer |
ID of Level 2 of the user-defined Control System tree. |
|
ControlSystemBreakdownUp3Id |
Integer |
ID of Level 1 (top node) of the user-defined Control System tree. |
|
ControlSystemBreakdown |
String |
Name of level 4 (bottom node) of the user-defined Control System tree. |
|
ControlSystemBreakdownUp1Summary |
String |
Name of level 3 of the user-defined Control System tree. |
|
ControlSystemBreakdownUp2Summary |
String |
Name of Level 2 of the user-defined Control System tree. |
|
ControlSystemBreakdownUp3Summary |
String |
Name of Level 1 (top node) of the user-defined Control System tree. |
|
ElectricalSourceElectricalRoom |
String |
Electrical Room, part of the asset energization location. |
|
ElectricalSourceMCCNumber |
String |
Motor control center (MCC), part of the asset energization location. |
|
ElectricalSourceMCCCubical |
String |
Motor control center (MCC) cubical number, part of the asset energization location. |
|
SAPFunctionalLocation |
String |
Equivalent reference tag from the asset maintenance systems (AMS), for example SAP, or Maximo. |
|
SAPMaterialCode |
String |
Material reference code typically from the asset maintenance systems (AMS), for example SAP or Maximo. |
|
ListPrice |
Decimal |
Cost of the asset, as stated by the vendor. |
|
PurchaseOrder |
String |
Purchase order for the asset. |
|
PurchaseDate |
String (Date) |
Date on which the asset was purchased. |
|
VendorId |
Integer |
Smart Completions ID for the company that made the asset. |
|
Vendor |
String |
Smart Completions name for the company that made the asset. |
|
RecordCreated |
String (Date) |
Read only. Date when the asset was created in Smart Completions. Captured by Smart Completions. |
|
RecordCreatedBy |
String |
Read only. Smart Completions name for the user who created the asset in Smart Completions. Captured by Smart Completions. |
|
RecordCreatedById |
Integer |
Read only. Smart Completions ID for the user who created the asset in Smart Completions. Captured by Smart Completions. |
|
RecordLastModified |
String (Date) |
Read only. Date when the asset was last updated in Smart Completions. Captured by Smart Completions. If the asset has not been updated since creation, this is the date the task was created. |
|
RecordLastModifiedBy |
String |
Read only. Smart Completions name for the user who last updated the asset in Smart Completions. Captured by Smart Completions. If the asset has not been updated since creation, this is the user who created the task. |
|
RecordLastModifiedById |
Integer |
Read only. Smart Completions ID for the user who last updated the asset in Smart Completions. Captured by Smart Completions. If the asset has not been updated since creation, this is the user who created the task. |
|
dtRemoved |
String (Date) |
Read only. Date when the asset was removed from Smart Completions. Captured by Smart Completions. |
|
RecordRemovedBy |
String |
Read only. Smart Completions name for the user who removed the asset from Smart Completions. Captured by Smart Completions. |
|
RecordRemovedById |
Integer |
Read only. Smart Completions ID for the user who removed the asset from Smart Completions. Captured by Smart Completions. |
|
WorkBreakdownUp3Id |
Integer |
Smart Completions ID for the Project (tier 1 of the Work Breakdown Structure) to which the asset belongs. |
|
CompanyInstanceId |
Integer |
Smart Completions ID for the Instance that contains the Project. |