UploadInspectionResultAttachment
Uploads or updates attachments related to inspection results, supporting quality documentation.
Input
Name | Type | Accepts Input Streams | Description |
IpEventId | Integer | False | The unique identifier for the inspection event. This identifier is used to link the attachment to a specific inspection event in the system, ensuring traceability and relevance. |
AsyncTrackerId | String | False | The identifier used to track the upload process of the attachment, especially for asynchronous file upload operations, providing operational transparency. |
AttachedDocumentId | Integer | False | The unique identifier for the document attachment associated with a work order. This identifier ensures that the uploaded attachment is correctly linked to the relevant record. |
CategoryName | String | False | Specifies the category of the attachment (for example, 'Inspection Report,' 'Defect Images,' or 'Maintenance Records'). Categories help organize and filter attachments based on their purpose. |
ContentRepositoryFileShared | Boolean | False | Indicates whether the attachment is shared. A value of 'true' means that the file is accessible to multiple users or processes; otherwise, it is private. |
DatatypeCode | String | False | An abbreviation that identifies the type of data being uploaded (for example, 'PDF,' or 'JPEG'). This field ensures compatibility with the system and helps categorize file formats.
The default value is FILE. |
Description | String | False | A text field providing a detailed description of the attachment. This field helps users understand the purpose or content of the uploaded file. |
DmDocumentId | String | False | The unique document identifier in the Document Management System (DMS). This identifier is critical for linking attachments to the correct document in the repository. |
DmFolderPath | String | False | The folder path within the DMS where the attachment is stored. This field helps in organizing and retrieving files efficiently. |
DmVersionNumber | String | False | Specifies the current version of the attachment in the DMS. This field supports version control for document updates and edits. |
DownloadInfo | String | False | A JSON object, represented as a string, containing metadata or details about the download process, such as file size or download URL. |
ErrorStatusCode | String | False | The code representing the status of the upload process in case of an error. This code helps in diagnosing and troubleshooting issues during file uploads. |
ErrorStatusMessage | String | False | A textual description of the error encountered during the upload process. This description provides clarity on the problem for corrective actions. |
ExpirationDate | Datetime | False | The date when the attachment's content expires or becomes invalid. This metric is useful for time-sensitive documents, ensuring they are not used beyond their validity period. |
FileLocation | String | False | The file's location on the user's desktop or local system. This field is used to specify the source location of the file being uploaded. |
FileName | String | False | The name of the file being uploaded. This name is used for identification and reference purposes in the Document Management system. |
FileUrl | String | False | The Uniform Resource Locator (URL) pointing to the file being uploaded. This URL allows direct access to the file from a remote source. |
Title | String | False | The title assigned to the attachment. Titles provide a user-friendly way to reference and identify uploaded files in the system. |
Uri | String | False | The Uniform Resource Identifier (URI) of the attachment. This URI is used to uniquely identify the resource being uploaded. |
Url | String | False | The Uniform Resource Locator (URL) pointing to the location of the file to be uploaded. This URL is often used for remote file uploads. |
Content | String | True | The content of the attachment provided as an InputStream. This is used when the file's local path or folder path is not specified, allowing direct binary content uploads. |
Result Set Columns
Name | Type | Description |
AsyncTrackerId | String | The identifier used to track the status and progress of the uploaded files. This identifier is returned after execution for tracking purposes. |
AttachedDocumentId | Integer | The unique identifier for the uploaded document. This identifier ensures that the attachment is correctly linked to the related work order or event. |
CategoryName | String | Specifies the category assigned to the attachment after upload. This field helps in categorizing and managing attachments within the system. |
ContentRepositoryFileShared | Boolean | Indicates whether the uploaded file is shared. This field ensures clarity about the file's accessibility status post-upload. |
CreatedBy | String | The user who created the attachment. This information is critical for auditing and accountability purposes. |
CreatedByUserName | String | The login name used by the user when creating the attachment. This name provides traceability for the source of the upload. |
CreationDate | Datetime | The date when the attachment record was created. This metric ensures accurate tracking of when the file was added to the system. |
DatatypeCode | String | The data type of the uploaded file (for example, 'PDF' or 'JPEG'). This output confirms the file type stored in the system for validation. |
Description | String | A description of the uploaded attachment, allowing users to easily identify the content or purpose of the file. |
DmDocumentId | String | The unique document identifier generated by the DMS for the uploaded file. This identifier ensures accurate storage and retrieval. |
DmFolderPath | String | The folder path in the DMS where the uploaded file is stored. This fieldsupports file organization and access. |
DmVersionNumber | String | The version number of the uploaded document in the DMS. This number enables tracking of document revisions. |
DownloadInfo | String | A JSON object, represented as a string, containing metadata or details about the uploaded file. These details might include file size, storage location, or download links. |
ErrorStatusCode | String | The code that identifies the error status of the upload process. This code helps in diagnosing issues during the upload and provides a standardized way to handle errors. |
ErrorStatusMessage | String | Detailed text describing the error encountered during the upload process. This detailed text provides clarity on the issue and assists in troubleshooting and resolution. |
ExpirationDate | Datetime | The date when the contents of the uploaded attachment expire. This metric is critical for managing time-sensitive documents and ensuring outdated content is not used. |
FileContents | Byte | The binary or textual content of the uploaded attachment. This content contains the actual data of the file stored in the system. |
FileName | String | The name of the file that was uploaded. This name is used for identification, reference, and retrieval in the Document Management system. |
FileUrl | String | The URL pointing to the uploaded file. This URL allows users to access the file directly from the system via a web link. |
FileWebImage | Byte | The Base64-encoded image of the uploaded file, typically used for displaying file previews in web interfaces or applications. |
LastUpdateDate | Datetime | The date and time when the uploaded document was most recently updated. These metrics ensure traceability of modifications to the file. |
LastUpdatedBy | String | The user identifier (ID) of the person who last updated the document. This ID is crucial for auditing and tracking changes to the uploaded file. |
LastUpdatedByUserName | String | The login name of the user who last updated the document. This name provides transparency about user activity in the system. |
Links | String | A collection of hyperlink relations associated with the resource instance. These links provide additional context or navigation paths for the attachment in the application. |
Title | String | The title of the uploaded attachment. Titles are used to provide a clear and user-friendly label for the file. |
UploadedFileContentType | String | The content type of the uploaded attachment. This field ensures compatibility and proper handling of the file in the system. |
UploadedFileLength | Integer | The size of the uploaded file in bytes. This value is useful for storage management and ensuring file size compliance with system limits. |
UploadedFileName | String | The name of the file after it has been uploaded to the system. This name ensures that the uploaded file can be easily referenced and retrieved. |
UploadedText | String | The textual content of the uploaded file. This content is commonly used for text-based files like logs or documents. |
Uri | String | The Uniform Resource Identifier (URI) of the uploaded attachment. This URI uniquely identifies the resource within the system, enabling precise management and retrieval. |
Url | String | The Uniform Resource Locator (URL) that provides a web-accessible location for the uploaded file. This URL is often used for direct file access from web applications. |
UserName | String | The login name of the user who added or modified the attachment. This name provides accountability and a record of user actions related to the attachment. |