Additional Information
The following table provides information about the fields of the request payload, along with the corresponding data types, and the data type descriptions:
|
Field Name |
Data Type |
Description and Possible Values |
|---|---|---|
|
documentId (Mandatory) |
String |
Specifies the document ID the system generates for a document. |
|
phaseCode (Mandatory) |
Integer |
Specifies the phaseCode for multiple phases. For more information on possible values, see Table Phase Codes and Category Codes. |
|
categoryCode (Mandatory) |
Integer |
Specifies categorycode that corresponds to a phasecode. For more information on possible values, see Table Phase Codes and Category Codes. |
|
Description (Optional) |
String |
Specifies the description of the document. |
|
fileName |
String |
Specifies the name of the file with extension. |
The following table provides information about the fields of the response payload, the corresponding data types, and the data type descriptions. To avoid repetition, fields that are also included in the request payload are excluded from the table.
|
Field Name |
Data Type |
Description and Possible Values |
|---|---|---|
|
title, name |
String |
Specifies the name or a title of the document. |
|
Phase |
String |
Specifies the phase in the lifecycle of a model or an equipment that the document is relevant for. For more information on possible values, see Table Phase Codes and Category Codes |
|
Category |
String |
Specifies the category that corresponds to a phase in the lifecycle of a model or an equipment that the document is relevant for. For more information on possible values, see the Phase Codes and Category Codes table. |
|
fileSize |
Integer |
Specifies the size of a document. |
|
fileSizeUnit |
Integer |
Specifies the unit used to measure the file size. |
|
mimeType |
String |
Specifies the mimetype of the document. |
|
Category Code |
Category |
|---|---|
|
1 |
Identification |
|
2 |
Technical Specification |
|
3 |
Drawings/Schemes |
|
4 |
Bills of Materials |
|
5 |
Certificates |
|
6 |
Installation/Dismantling |
|
7 |
Operation |
|
8 |
Safety |
|
9 |
Inspection/Preventive Maintenance/Testing/Calibration |
|
10 |
Corrective Maintenance/Repair |
|
11 |
Commercial Documents |
|
12 |
Others |
|
14 |
Decommissioning Plan |
|
15 |
Decommissioning Checklist |
|
16 |
Decommissioning Report |
|
17 |
Dismantling Guide |
|
Phase Code |
Phase |
|---|---|
|
1 |
Design |
|
2 |
Acquisition |
|
3 |
Installation |
|
4 |
Operation |
|
5 |
Maintenance |
|
6 |
Decommissioning |
|
7 |
Dismantle |
|
8 |
Disposal |
|
File Extension |
MIME Type |
|---|---|
|
.txt |
text/plain |
|
.jpg |
image/jpeg |
|
.jpeg |
image/jpeg |
|
.jpe |
image/jpeg |
|
.jfif |
image/jpeg |
|
.jpg |
image/pjpeg |
|
.doc |
application/msword |
|
|
application/pdf |
|
.png |
image/png |
|
.bmp |
image/bmp |
|
.dib |
image/bmp |
|
.bmp |
image/x-windows-bmp |
|
.gif |
image/gif |
|
.tif |
image/tiff |
|
.tiff |
image/tiff |
|
.ppt |
application/mspowerpoint |
|
.ppt |
application/powerpoint |
|
.docx |
application/vnd.openxmlformats-officedocument.wordprocessingml.document |
|
.docm |
application/vnd.ms-word.document.macroenabled.12 |
|
.dotx |
application/vnd.openxmlformats-officedocument.wordprocessingml.template |
|
.odt |
application/vnd.oasis.opendocument.text |
|
.rtf |
application/msword |
|
.xps |
application/vnd.ms-xpsdocument |
|
.pptx |
application/vnd.openxmlformats-officedocument.presentationml.presentation |
|
.vds |
application/octet-stream |
|
.dif |
application/octet-stream |
|
.prn |
application/octet-stream |
|
.csv |
application/vnd.ms-excel |
|
.slk |
application/vnd.ms-excel |
|
.xlsb |
application/vnd.ms-excel.sheet.binary.macroenabled.12 |
|
.xlsm |
application/vnd.ms-excel.sheet.macroenabled.12 |
|
.xltx |
application/vnd.openxmlformats-officedocument.spreadsheetml.template |
|
.ods |
application/vnd.oasis.opendocument.spreadsheet |
|
.xls |
application/excel |
|
.xlsx |
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
|
.html |
text/html |
|
.htm |
text/html |
|
.avi |
video/avi |
|
.mp4 |
video/mp4 |
|
.wav |
audio/wav |
|
.mp3 |
audio/mpeg3 |
|
.mp3 |
audio/mp3 |
|
.xml |
text/xml |
|
.odp |
application/vnd.oasis.opendocument.presentation |
|
.dwg |
application/acad |
|
.dwg |
application/x-acad |
|
.dwg |
application/autocad_dwg |
|
.dwg |
image/x-dwg, application/dwg |
|
.dwg |
application/x-dwg |
|
.dwg |
application/x-autocad |
|
.dwg |
image/vnd.dwg |
|
.dwg |
drawing/dwg |
|
.dwg |
application/octet-stream |
|
.dxf |
application/dxf |
|
.dxf |
application/x-autocad |
|
.dxf |
application/x-dxf |
|
.dxf |
drawing/x-dxf |
|
.dxf |
image/vnd.dxf |
|
.dxf |
image/x-autocad |
|
.dxf |
image/x-dxf |
|
.dxf |
zz-application/zz-winassoc-dxf |
|
.dxf |
application/octet-stream |
|
.sat |
application/x-sat |
|
.sat |
image/x-sat |
|
.sat |
application/octet-stream |
|
.stp |
application/step |
|
.stp |
application/x-step |
|
.stp |
application/octet-stream |
|
.aml |
application/octet-stream |