Create, update, or remove documents.
Supported HTTPS Methods: GET, PUT, PATCH, POST
Request URL:
-
Create or update document - <HOSTNAME>/sc/datalake/v1/Instances(2)/Documentss
-
Remove document - <HOSTNAME>/sc/datalake/v1/Instances(2)/Documentss(37786)
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 documents:
{
"DocumentName": "_CE_SMART FORM (STP02)",
"Description": "All Inspection Types for Smart Forms",
"Revision": "0",
"IsAsBuilt": false,
"DocumentType": "test",
"DocumentTypeId": 882,
"DocumentCategory": "Administration Document",
"DocumentCategoryId": 11,
"DocumentDiscipline": "MULTI",
"DocumentDisciplineId": 525,
"DocumentStatus": "AB",
"DocumentStatusId": 49,
"DocumentManufacturerId": 596,
"Comment": null,
"UsesProcessBreakdown": true,
"PhysicalLocationUp2Id": 415,
"PhysicalLocationUp3Id": 414,
"ProcessBreakdownUp2Id": 17164,
"ProcessBreakdownUp3Id": 17163,
"ClientTransmittalId": null,
"WorkGroupID": 1068,
"DataExchangeId": null,
"DataExchangeSourceId": null,
"ExternalSourceId": null,
"DataSourceId": null,
"FileID": null,
"DocumentSize": null,
"DocumentURL": null,
"IsCheckedOut": null,
"DateExpire": "2023-11-22T00:00:00Z",
"NeverExpire": false,
}
Sample request payload for removing documents:
{
"dtRemoved": "2023-07-14T16:09:13-06:00"
}
Request payload parameters:
|
|
Required, Optional, |
|
DocumentName |
String |
GET - Optional PUT - Optional PATCH - Optional POST - Required |
Name of the document. |
Description |
String |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Description of the document. |
Revision |
String |
GET - Optional PUT - Optional PATCH - Optional POST - Required |
Revision number of the version of the controlled document. A controlled document has version control through workflow and revisions. |
IsAsBuilt |
Boolean |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Built status of the document. |
DocumentType |
String |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Smart Completions name for the document type identified by DocumentTypeId. |
DocumentTypeId |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Smart Completions ID for the document type. |
DocumentCategory |
String |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Smart Completions name for the document category, for example mechanical, electrical, instrumentation, piping, or civil. Identified by DocumentCategoryId. |
DocumentCategoryId |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Smart Completions ID for the document category. |
DocumentDiscipline |
String |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Smart Completions name for the document discipline, for example cable, civil, or electrical. Identified by DocumentDisciplineId. |
DocumentDisciplineId |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Required |
Smart Completions ID for the document discipline, for example cable, civil, or electrical. |
DocumentStatus |
String |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Smart Completions name for the document status. Identified by DocumentStatusId. |
DocumentStatusId |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Smart Completions ID for the document status. |
DocumentManufacturerId |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Smart Completions ID for the document manufacturer. |
Comment |
String |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Comments about the document. |
UsesProcessBreakdown |
Boolean |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Indicates whether the process is broken down by the PBS (true) or the LBS (false). |
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 document is assigned to. Do not use this parameter unless the Location Breakdown Structure API has been used to align the Location Breakdown Structure between the geographical location and information management systems (for example Smart Construction and HxGN SDx). |
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 document is assigned to. Do not use this parameter unless the Location Breakdown Structure API has been used to align the Location Breakdown Structure between the geographical location and information management systems (for example Smart Construction and HxGN SDx). |
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 document is assigned to. Do not use this parameter unless the Process Breakdown Structure API has been used to align the PBS between the construction and information management systems (for example Smart Construction and HxGN SDx). |
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 (PBS) that the asset is assigned to. Do not use this parameter unless the Process Breakdown Structure API has been used to align the PBS between the construction and information management systems (for example Smart Construction and HxGN SDx). |
ClientTransmittalId |
String |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Internal ID for associated document transmittal. A transmittal is a method to track transfer/submission of documents from Smart Completions to some receiving company. |
WorkGroupID |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Internal ID of the workgroup associated with the document. |
DataExchangeId |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Internal ID of the Smart Completions Data Exchange module. This module configures point-to-point integrations with external systems, such as HxGN SDx, Aconex, and Team Binder. |
DataExchangeSourceId |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
ID of the external system that the Data Exchange module pulls data or documents from. For example, the Data Exchange module can pull data or documents from HxGN SDx, Aconex, and Team Binder. |
ExternalSourceId |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Document ID from the external system. This can be different than what is imported or loaded into Smart Completions. Usually, the Smart Completions document ID is the same as the external source document ID. But if they are not, you can use this field to find documents based on the external source ID. |
DataSourceId |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
ID of the application that the document came from, for example HxGN SDx or Aconex. |
FileID |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
ID of the non-PDF file attached to the document. |
DocumentSize |
Integer |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Size of the document uploaded for the revision. |
DocumentURL |
String (Link) |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
The path used to retrieve the latest document from the system. Users with different programs to house the document can upload the URL into this field. |
IsCheckedOut |
Boolean |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Indicates whether the document is checked out (True) or not (False). |
DateExpire |
String (Date) |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Expiration date of the document. |
NeverExpire |
Boolean |
GET - Optional PUT - Optional PATCH - Optional POST - Optional |
Indicates whether the document has an expiration date (False) or not (True). |
dtRemoved |
String (Date) |
GET - Optional PUT - Optional PATCH - Optional POST - Unused |
Date on which the document was removed. |
Sample response:
{
"@odata.context":"https://localhost:5001/DataLake/v1/$metadata#Instances(2)/
Documentss/$entity",
"Id": 37786,
"DocumentId": 37786,
"DocumentName": "_CE_SMART FORM (STP02)",
"Description": "All Inspection Types for Smart Forms",
"DCTMNo": null,
"IsAsBuilt": false,
"DocumentType": "test",
"DocumentTypeId": 882,
"DocumentCategory": "Administration Document",
"DocumentCategoryId": 11,
"DocumentDiscipline": "MULTI",
"DocumentDisciplineId": 525,
"DocumentStatus": "AB",
"DocumentStatusId": 49,
"DocumentManufacturer": "Hexagon PPM",
"DocumentManufacturerId": 596,
"Comment": null,
"Revision": "0",
"RevisionDescription": null,
"UsesProcessBreakdown": true,
"PhysicalLocationUp2Summary": "10-10 - Facility 1",
"PhysicalLocationUp2Id": 415,
"PhysicalLocationUp3Summary": "10 - Plant",
"PhysicalLocationUp3Id": 414,
"ProcessBreakdownUp2Summary": "2000-1 - Process Area",
"ProcessBreakdownUp2Id": 17164,
"ProcessBreakdownUp3Summary": "2000 - Plant",
"ProcessBreakdownUp3Id": 17163,
"ClientTransmittalId": null,
"WorkGroupID": 1068,
"WorkGroup": "Commissioning",
"DataExchangeId": null,
"DataExchange": null,
"DataExchangeSourceId": null,
"DataExchangeSource": null,
"ExternalSourceId": null,
"DataSourceId": null,
"DocumentSource": null,
"PDFFileID": null,
"PDFFileName": null,
"FileID": null,
"FileName": null,
"DocumentFileName": null,
"DocumentMimeType": null,
"DocumentSize": null,
"DocumentURL": null,
"IsCheckedOut": null,
"DateExpire": "2023-11-22T00:00:00Z",
"NeverExpire": false,
"RecordCreated": "2023-11-13T11:11:38.997Z",
"RecordCreatedById": 1039,
"RecordCreatedBy": "Sai, Sai",
"RecordLastModified": "2023-11-13T11:19:27Z",
"RecordLastModifiedBy": "Sai, Sai",
"RecordLastModifiedById": 1039,
"dtRemoved": null,
"RecordRemovedById": null,
"RecordRemovedBy": null,
"WorkBreakdownUp3Id": 294,
"CompanyInstanceId": 2
}
Response parameters:
Response Parameter |
Data Type |
Description |
@odata.context |
String |
Request URL. |
Id |
Integer |
Smart Completions ID assigned to the document upon creation. |
DocumentID |
Integer |
ID of the document. |
DocumentName |
String |
Name of the document. |
Description |
String |
Description of the document. |
DCTMNo |
String |
Vendor number of the document. |
IsAsBuilt |
Boolean |
Built Status of the document. |
DocumentType |
String |
Smart Completions name for the document type identified by the DocumentTypeId. |
DocumentTypeId |
Integer |
Smart Completions ID for the document type. |
DocumentCategory |
String |
Smart Completions name for the document category, for example mechanical, electrical, instrumentation, piping, or civil. |
DocumentCategoryId |
Integer |
Smart Completions ID for the document category. Identified by DocumentCategoryId. |
DocumentDiscipline |
String |
Smart Completions name for the document discipline, for example cable, civil, or electrical. Identified by DocumentDisciplineId. |
DocumentDisciplineId |
Integer |
Smart Completions ID for the document discipline, for example cable, civil, or electrical. |
DocumentStatus |
String |
Smart Completions name for the document status. Identified by DocumentStatusId. |
DocumentStatusId |
Integer |
Smart Completions ID for the document status. |
DocumentManufacturerId |
Integer |
Smart Completions ID for the document manufacturer. |
Comment |
String |
Comments about the document. |
Revision |
String |
Revision number of the version of the controlled document. A controlled document has version control through workflow and revisions. |
RevisionDescription |
String |
Description of the revision number. |
UsesProcessBreakdown |
Boolean |
Indicates whether the process is broken down by the PBS (true) or the LBS (false). |
PhysicalLocationUp2Summary |
String |
Smart Completions summary for the Process Area (tier 2 of the Location Breakdown Structure) that the document is assigned to. |
PhysicalLocationUp2Id |
Integer |
Smart Completions ID for the Process Area (tier 2 of the Location Breakdown Structure) that the document is assigned to. |
PhysicalLocationUp3Summary |
String |
Smart Completions summary for the Plant (tier 1 of the Location Breakdown Structure) that the document is assigned to. |
PhysicalLocationUp3Id |
Integer |
Smart Completions ID for the Plant (tier 1 of the Location Breakdown Structure) that the document is assigned to. |
ProcessBreakdownUp2Summary |
String |
Smart Completions summary for the Process Area (tier 2 of the Process Breakdown Structure) that the document is assigned to. |
ProcessBreakdownUp2Id |
Integer |
Smart Completions ID for the Process Area (tier 2 of the Process Breakdown Structure) that the document is assigned to. |
ProcessBreakdownUp3Summary |
String |
Smart Completions summary for the Plant (tier 1 of the Process Breakdown Structure) that the document is assigned to. |
ProcessBreakdownUp3Id |
Integer |
Smart Completions ID for the Plant (tier 1 of the Process Breakdown Structure) that the document is assigned to. |
ClientTransmittalId |
Integer |
Internal ID for associated document transmittal. A transmittal is a method to track transfer/submission of documents from Smart Completions to some receiving company. |
WorkGroupID |
Integer |
Internal ID of the workgroup associated with the document. |
WorkGroup |
String |
Name of the workgroup associated with the document. This is useful for querying for documents that service specific workgroups. |
DataExchangeId |
Integer |
Internal ID of the Smart Completions Data Exchange module. This module configures point-to-point integrations with external systems, such as HxGN SDx, Aconex, and Team Binder. |
DataExchange |
String |
Name of the Smart Completions Data Exchange module. This module configures point-to-point integrations with external systems, such as HxGN SDx, Aconex, and Team Binder. |
DataExchangeSourceId |
Integer |
ID of the external system that the Data Exchange module pulls data or documents from. For example, the Data Exchange module can pull data or documents from HxGN SDx, Aconex, and Team Binder. |
DataExchangeSource |
Integer |
ID of the external system that the Data Exchange module pulls data or documents from. For example, the Data Exchange module can pull data or documents from HxGN SDx, Aconex, and Team Binder. |
ExternalSourceId |
Integer |
Document ID from the external system. This can be different than what is imported or loaded into Smart Completions. Usually, the Smart Completions document ID is the same as the external source document ID. But if they are not, you can use this field to find documents based on the external source ID. |
DataSourceId |
Integer |
ID of the application that the document came from, for example HxGN SDx or Aconex. |
DocumentSource |
String |
Name of the external application that the document came from, such as HxGN SDx or Aconex. This value is useful for finding documents from specific source applications. If the document does not come from an external application, this value is not used. |
PDFFileID |
Integer |
ID of the PDF file attached to the document. |
PDFFileName |
String |
Name of the PDF file attached to the asset document. Identified by PDFFileId. |
FileId |
Integer |
ID of the non-PDF file attached to the document. |
FileName |
String |
Name of the non-PDF file attached to the document. Identified by FileId. |
DocumentFileName |
String |
Name of the file attached for revision purposes. |
DocumentMimeType |
String |
File type of DocumentFileName, for example PDF, docx, or pid. |
DocumentSize |
Integer |
Size of the document uploaded for revision. |
DocumentURL |
String (Link) |
The path used to retrieve the latest document from the system. Users with different programs to house the document can upload the URL into this field. |
IsCheckedOut |
Boolean |
Indicates whether the document is checked out (True) or not (False). |
DateExpire |
String (Date) |
Expiration date of the document. |
NeverExpire |
Boolean |
Indicates whether the document has an expiration date (False) or not (True). |
RecordCreated |
String (Date) |
Read only. Date when the document was created in Smart Completions. Captured by Smart Completions. |
RecordCreatedById |
Integer |
Read only. Smart Completions ID for the user who created the document in Smart Completions. Captured by Smart Completions. |
RecordCreatedBy |
String |
Read only. Smart Completions name for the user who created the document in Smart Completions. Captured by Smart Completions. |
RecordLastModified |
String (Date) |
Read only. Date when the document was last updated in Smart Completions. Captured by Smart Completions. If the document has not been updated since creation, this is the date the document was created. |
RecordLastModifiedBy |
String |
Read only. Smart Completions name for the user who last updated the document in Smart Completions. Captured by Smart Completions. If the document has not been updated since creation, this is the user who created the document. |
RecordLastModifiedById |
Integer |
Read only. Smart Completions ID for the user who last updated the document in Smart Completions. Captured by Smart Completions. If the document has not been updated since creation, this is the user who created the document. |
dtRemoved |
String (Date) |
Read only. Date when the document was removed from Smart Completions. Captured by Smart Completions. |
RecordRemovedById |
Integer |
Read only. Smart Completions ID for the user who removed the document from Smart Completions. Captured by Smart Completions. |
RecordRemovedBy |
String |
Read only. Smart Completions name for the user who removed the document from Smart Completions. Captured by Smart Completions. |
WorkBreakdownUp3Id |
Integer |
Smart Completions ID for the Project (tier 1 of the Work Breakdown Structure) that the document was added to. |
CompanyInstanceId |
Integer |
Smart Completions ID for the Instance that contains the Project. |