Assign or remove one or more physical locations (tier 4 of the LBS) from documents.
Supported HTTPS Methods: GET, PUT, PATCH, POST
Request URL:
<HOSTNAME>/sc/datalake/v1/Instances(2)/DocumentLocations
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:
{
"DocumentID": 37786,
"PhysicalLocationId": 414,
"dtRemoved": "2023-07-14T16:09:13-06:00"
}
Request payload parameters:
|
|
|
Required, Optional, |
|
|---|---|---|---|
|
DocumentID |
Integer |
Required |
Smart Completions ID for the document. |
|
PhysicalLocationId |
Integer |
Required |
Smart Completions ID for the physical location (tier 4 of the Location Breakdown Structure) to add or remove from the document. |
|
dtRemoved |
String (Date) |
Get - Optional Put - Optional Patch - Optional Post - Unused |
Date on which the physical location was removed from the document. |
Sample response:
{
"@odata.context": "https:// localhost:5001/DataLake/v1/
$metadata#Instances(2)/ DocumentLocations /$entity",
"Id": 188,
"TypeId": 4,
"DocumentId": 37786,
"PhysicalLocationId": 414,
"Document": "_CE_SMART FORM (STP02)",
"PhysicalLocation": "Location 1",
"RecordCreated": "2023-11-13T12:46:55Z",
"RecordCreatedBy": "Sai Sai",
"RecordCreatedById": 1039,
"RecordLastModified": null,
"RecordLastModifiedBy": "Sai Sai",
"RecordLastModifiedById": 1039,
"dtRemoved": null,
"RecordRemovedBy": null,
"RecordRemovedById": null,
"CompanyInstanceId": 2
}
Response parameters:
|
Response Parameter |
Data Type |
Description |
|---|---|---|
|
@odata.context |
String |
Request URL. |
|
Id |
Integer |
Smart Completions ID assigned to the physical location upon linking to the document. |
|
TypeId |
Integer |
Smart Completions ID for the physical location type (tier 4 of the Location Breakdown Structure) to add or remove from the document. |
|
DocumentID |
Integer |
Smart Completions ID of the document. |
|
PhysicalLocationId |
Integer |
Smart Completions ID for the physical location (tier 4 of the Location Breakdown Structure) to add or remove from the document. |
|
Document |
String |
Name of the document. |
|
PhysicalLocation |
String |
Smart Completions name for the physical location (tier 4 of the Location Breakdown Structure). |
|
RecordCreated |
String (Date) |
Read only. Date when the physical location was assigned to the document in Smart Completions. Captured by Smart Completions. |
|
RecordCreatedBy |
String |
Read only. Smart Completions name for the user who assigned the physical location to the document in Smart Completions. Captured by Smart Completions. |
|
RecordCreatedById |
Integer |
Read only. Smart Completions ID for the user who assigned the physical location to the document in Smart Completions. Captured by Smart Completions. |
|
RecordLastModified |
String (Date) |
Read only. Date when the physical location assignment to the document 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 updated the physical location assignment to the document 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 for the user who last updated the physical location assignment to the document in Smart Completions. Captured by Smart Completions. If the assignment has not been updated since creation, this is the user who created the assignment. |
|
dtRemoved |
String (Date) |
Read only. Date when the physical location assignment was removed from the document in Smart Completions. Captured by Smart Completions. |
|
RecordRemovedBy |
String |
Read only. Smart Completions name for the user who removed the physical location assignment to the document in Smart Completions. Captured by Smart Completions. |
|
RecordRemovedById |
Integer |
Read only. Smart Completions ID for the user who removed the physical location assignment to the document in Smart Completions. Captured by Smart Completions. |
|
CompanyInstanceId |
Integer |
Smart Completions ID for the Instance that contains the Project. |