Create and update all four tiers of the Smart Completions LBS hierarchy: Plant, Process Areas, Areas, and Physical Locations.
We recommend using this endpoint only in certain scenarios. For guidance, see LBS API usage guidance.
Supported HTTPS Methods: POST, PUT, PATCH
Request URLs:
-
POST - <HOSTNAME>/sc/datalake/v1/Instances(2)/PhysicalLocationss
-
PUT or PATCH - <HOSTNAME>/sc/datalake/v1/Instances(2)/PhysicalLocationss(1046)
The PhysicalLocationss value (in this example, 1046) is the WBS Id or WorkBreakdownId value, which is assigned to the WBS when it is created.
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 POST request payload to create a plant (tier 1 of the LBS hierarchy):
{
"Number": "1000",
"Name": "LBS1",
"PhysicalLocationTypeId": 1,
"CompanyInstanceID": 1
}
Sample POST request payload to create a process area (tier 2 of the LBS hierarchy):
{
"Number": "A255",
"Name": "A251 Stage",
"PhysicalLocationTypeId": 2,
"CompanyInstanceId": 1,
"ParentId": 1050
}
Sample PUT or PATCH request payload:
{
"Number":"1234",
"Name": "Test LBS",
"PhysicalLocationTypeId": 2,
"ParentId": 1046,
"CompanyInstanceId": 1,
}
Request payload parameters:
|
|
|
Required, Optional, |
|
|---|---|---|---|
|
Number |
String |
PUT - Optional PATCH - Optional POST - Required |
Source system ID for the LBS item. |
|
Name |
String |
PUT - Optional PATCH - Optional POST - Required |
Source system name for the LBS item. |
|
PhysicalLocationTypeId |
Integer |
PUT - Optional PATCH - Optional POST - Required |
Smart Completions hierarchy tier for LBS item: 1 - Plant 2 - Process Area 3 - Area 4 - Physical Location |
|
CompanyInstanceId |
Integer |
PUT - Optional PATCH - Optional POST - Required |
Smart Completions ID for the Instance that contains the Project. |
|
ParentId |
Integer |
PUT - Optional PATCH - Optional POST - Unused |
ID assigned by Smart Completions to the parent LBS item based on |
Sample POST response:
{
"@odata.context": "https://sc.acme.com/CR-3970511/sc/datalake/v1/
$metadata#Instances(2)/PhysicalLocationss/$entity",
"Id": 103,
"PhysicalLocationId": 103,
"Number": "900",
"Name": "Test1",
"Summary": "900 - Test1",
"PhysicalLocationType": "Plant",
"PhysicalLocationTypeId": 1,
"ParentId": null,
"ParentNumber": null,
"ParentName": null,
"ParentSummary": null,
"EmergencyNumber": null,
"RadioChannel": null,
"PhysicalLocationSequence": null,
"PhysicalLocationCustody": null,
"RecordCreated": "2023-09-27T09:28:35.6Z",
"RecordCreatedBy": null,
"RecordCreatedById": null,
"RecordLastModified": null,
"RecordLastModifiedBy": null,
"RecordLastModifiedByID": null,
"dtRemoved": null,
"RecordRemovedBy": null,
"RecordRemovedByID": null,
"WorkBreakdownUp3Id": null,
"CompanyInstanceId": 2
}
Sample PUT or PATCH response:
The API does not send a response to PUT or PATCH requests.
Response parameters:
|
|
|
|
|---|---|---|
|
@odata.context |
String |
Request Id. |
|
Id |
Integer |
Unique ID of the PhysicalLocationss entity. |
|
PhysicalLocationId |
Integer |
Unique ID of the Process. |
|
Number |
String |
Unique ID of the LBS item. |
|
Name |
String |
Unique name of the LBS item. |
|
Summary |
String |
The unique value Smart Completions uses to identify the LBS item. The value is a concatenation of the item’s NUMBER and NAME. |
|
PhysicalLocationType |
String |
Name of the PBS hierarchy tier that the item belongs to: Plant,Process Area, Area, Location. |
|
PhysicalLocationTypeId |
Integer |
Level of the LBS hierarchy tier that the item belongs to: 1 - Plant 2 - Facility 3 - Area 4 - Location |
|
ParentId |
Integer |
ID of the LBS item that the new item was created under. |
|
ParentNumber |
String |
Number of the LBS item that the new item was created under. |
|
ParentName |
String |
Name of the LBS item that the new item was created under. |
|
ParentSummary |
String |
The unique value Smart Completions uses to identify the LBS item's parent. The value is a concatenation of the item's NUMBER and NAME. |
|
EmergencyNumber |
String |
The telephone number to call when a safety issue arises in the plant. This number is defined in the safety isolation module. |
|
RadioChannel |
String |
The radio channel to call when a safety issue arises in the plant. This number is defined in the safety isolation module. |
|
PhysicalLocationSequence |
Integer |
The position of the LBS item within the LBS hierarchy relative to its siblings. If omitted, the items are organized alpha-numerically. |
|
PhysicalLocationCustody |
Integer |
ID of the workgroup assigned to a specific LBS. |
|
RecordCreated |
String(date) |
Read only. Date when the LBS item was created in Smart Completions. Captured by Smart Completions. |
|
RecordCreatedBy |
String |
Read only. Smart Completions user who created the LBS item in Smart Completions. Captured by Smart Completions. |
|
RecordCreatedById |
Integer |
Read only. Smart Completions user ID who created the LBS item in Smart Completions. Captured by Smart Completions. |
|
RecordLastModified |
String(date) |
Read only. Date when the LBS item was last updated in Smart Completions. Captured by Smart Completions. If the item has not been updated since creation, this is the date the item was created. |
|
RecordLastModifiedBy |
String |
Read only. Smart Completions user who last updated the LBS item in Smart Completions. Captured by Smart Completions. If the item has not been updated since creation, this is the user who created the item. |
|
RecordLastModifiedById |
Integer |
Read only. Smart Completions user ID who last updated the LBS item in Smart Completions. Captured by Smart Completions. If the item has not been updated since creation, this is the user who created the item. |
|
dtRemoved |
String(date) |
Read only. Date when the LBS item was removed from Smart Completions. Captured by Smart Completions. |
|
RecordRemovedBy |
String |
Read only. Smart Completions user who deleted the LBS item from Smart Completions. Captured by Smart Completions. |
|
RecordRemovedBy |
Integer |
Read only. User ID of the Smart Completions user who deleted the LBS item from Smart Completions. Captured by Smart Completions. |
|
WorkBreakdownUp3Id |
Integer |
Project ID that was linked to process. |
|
CompanyInstanceId |
Integer |
Smart Completions ID for the Instance that contains the Project. |