Assign or remove one or more Systems (tier 3 of the PBS) from documents.
Supported HTTPS Methods: GET, PUT, PATCH, POST
Request URL:
<HOSTNAME>/sc/datalake/v1/Instances(2)/DocumentSystems
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,
"ProcessBreakdownId": 17165,
"dtRemoved": "2023-07-14T16:09:13-06:00"
}
Request payload parameters:
|
|
|
Required, Optional, |
|
|---|---|---|---|
|
DocumentID |
Integer |
Required |
Smart Completions ID for the document. |
|
ProcessBreakdownId |
Integer |
Required |
Smart Completions ID for the System (tier 3 of the Process Breakdown Structure) to add or remove from the document. |
|
dtRemoved |
String (Date) |
Get - Optional Put - Optional Patch - Optional Post - Unused |
Date on which the System was removed from the document. |
Sample response:
{
"@odata.context": "https:// localhost:5001/DataLake/v1/$metadata#Instances(2)/
DocumentSystems/$entity",
"Id": 4993,
"TypeId": 3,
"DocumentId": 37786,
"ProcessBreakdownId": 17165,
"Document": "_CE_SMART FORM (STP02)",
"ProcessBreakdown": "System",
"RecordCreated": "2023-11-13T12:29:40Z",
"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 system upon linking to the document. |
|
TypeId |
Integer |
Smart Completions ID of the system type (tier 3 of the Process Breakdown Structure) to add or remove from the document. |
|
DocumentID |
Integer |
Smart Completions ID of the document. |
|
ProcessBreakdownId |
Integer |
Smart Completions ID for the System (tier 3 of the Process Breakdown Structure) to add or remove from the document. |
|
Document |
String |
Name of the document. |
|
ProcessBreakdown |
String |
Smart Completions summary for of the system added to or removed from to the document. |
|
RecordCreated |
String (Date) |
Read only. Date when the System 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 System to the document in Smart Completions. Captured by Smart Completions. |
|
RecordCreatedById |
Integer |
Read only. Smart Completions ID for the user who assigned the System to the document in Smart Completions. Captured by Smart Completions. |
|
RecordLastModified |
String (Date) |
Read only. Date when the System 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 System 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 System 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 System 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 System assignment to the document in Smart Completions. Captured by Smart Completions. |
|
RecordRemovedById |
Integer |
Read only. Smart Completions ID for the user who removed the System assignment to the document in Smart Completions. Captured by Smart Completions. |
|
CompanyInstanceId |
Integer |
Smart Completions ID for the Instance that contains the Project. |