UploadItemCategoriesAttachment
Uploads or updates attachments for item categories, providing additional context or documentation.
Input
Name | Type | Accepts Input Streams | Description |
ItemCategoriesUniqID | Integer | False | Represents the hash key that uniquely identifies the attributes forming the composite key for the item category attachment. This key ensures accurate mapping and retrieval of item category-specific attachments. |
AttachmentDFF | String | False | Defines the descriptive flexfields (DFF) associated with the attachment resource. These flexfields allow custom metadata attributes to be assigned to attachments for better classification and tracking. |
CategoryName | String | False | Indicates the category classification of the attachment. This classification helps in organizing and managing attachments based on business-specific categories, improving accessibility and searchability. |
ContentRepositoryFileShared | Boolean | False | Specifies whether the attachment is shared within the content repository. If set to 'true', the file is accessible by multiple users or processes within the system. |
DatatypeCode | String | False | Represents an abbreviation that identifies the data type of the attachment, ensuring the system correctly interprets the file format for processing and rendering.
The default value is FILE. |
Description | String | False | Provides a textual description of the attachment. This description helps users understand the purpose, context, or contents of the attached file. |
DmFolderPath | String | False | Specifies the folder path where the attachment is stored in the document management system. This path ensures proper organization, version control, and easy retrieval of files. |
DmVersionNumber | String | False | Indicates the current version number of the attachment. This version number helps track document revisions, supporting version control and regulatory compliance. |
DownloadInfo | String | False | Contains a JSON-formatted string with metadata about the attachment, such as file size, format, permissions, and security settings. |
ErrorStatusCode | String | False | Specifies an abbreviation representing the error code returned if an issue occurs during attachment processing. This code abbreviation helps in diagnosing and resolving upload failures. |
ErrorStatusMessage | String | False | Provides a detailed message describing any errors encountered during attachment upload or retrieval. This message assists in debugging and system notifications. |
FileLocation | String | False | Indicates the location of the file on the user's desktop before upload. This location ensures proper file selection and tracking during the upload process. |
FileName | String | False | Specifies the name of the file being uploaded as an attachment. This name ensures accurate file identification within the system. |
FileUrl | String | False | Contains the Uniform Resource Locator (URL) where the attachment file is stored. This URL enables users to access and retrieve the document online. |
Title | String | False | Defines the title of the attachment. This title provides an additional way to categorize and label the file for easy identification and retrieval. |
Uri | String | False | Represents the Uniform Resource Identifier (URI) that uniquely identifies the attachment within the system. This URI structured reference supports programmatic access and integrations. |
Url | String | False | Contains the URL used to locate and retrieve the attachment. This URL ensures users can easily access the file through web-based interfaces. |
Content | String | True | Holds the attachment content in InputStream format when LocalFilePath or FolderPath is not specified. This field allows direct file uploads without requiring a predefined storage path. |
Result Set Columns
Name | Type | Description |
AttachmentDFF | String | Returns the descriptive flexfields (DFF) metadata associated with the attachment after processing, ensuring that any custom attributes are retained. |
CategoryName | String | Returns the category classification of the attachment after processing, confirming that it is stored under the correct classification. |
ContentRepositoryFileShared | Boolean | Indicates whether the attachment remains shared after processing. If set to 'true', the file is accessible by multiple users or processes. |
CreatedBy | String | Specifies the user who originally created the attachment record. This value helps maintain an audit trail of document ownership. |
CreationDate | Datetime | Indicates the date when the attachment record was created. This date is useful for historical tracking and auditing purposes. |
DatatypeCode | String | Returns the abbreviation identifying the data type of the attachment after processing, ensuring correct file type recognition and processing. |
Description | String | Provides the description of the attachment after processing, ensuring that any updates or modifications to metadata are accurately captured. |
DmFolderPath | String | Specifies the folder path where the attachment is stored after processing, confirming its proper organization in the document repository. |
DocumentURL | String | Contains the final URL where the catalog attachment is stored. This URL allows users to access and manage the document efficiently. |
DownloadInfo | String | Returns a JSON-formatted string containing metadata about the attachment, such as file size, format, and accessibility settings. |
ErrorStatusCode | String | Returns an abbreviation representing any error code encountered during processing. This code abbreviation helps troubleshoot issues related to the attachment. |
ErrorStatusMessage | String | Provides a detailed message describing any errors that occurred during attachment processing. This message is useful for debugging and system monitoring. |
FileName | String | Returns the name of the attachment file after processing. This name ensures that the correct file is referenced in the catalog system. |
FileUrl | String | Contains the final URL pointing to the attachment after processing. This URL enables users to retrieve the document online. |
LastUpdateDate | Datetime | Indicates the date and time when the attachment document was last updated. This information ensures version tracking and data accuracy. |
LastUpdatedBy | String | Identifies the login of the user who last modified the attachment. This information supports accountability and compliance monitoring. |
Links | String | Specifies the link relations associated with the resource instance. These links establish navigational relationships between the attachment and related resources, enabling integration, referencing, and structured access within the system. |
Title | String | Represents the title assigned to the attachment. The title provides a meaningful label to help categorize and identify the attachment within the document repository. |
UploadedFileContentType | String | Indicates the content type of the uploaded file. This content type ensures that files are correctly processed and rendered by the system. |
UploadedFileLength | Integer | Specifies the size of the uploaded attachment file in bytes. This information is used to manage storage allocation, file transfer limits, and performance optimization. |
UploadedFileName | String | Defines the name of the file after it has been uploaded to the system. This name ensures consistency in file management and facilitates accurate retrieval of attachments. |
UploadedText | String | Contains any extracted text from the uploaded attachment. This extracted text is useful for indexing documents, enabling full-text search capabilities, and supporting compliance or auditing requirements. |
Uri | String | Represents the URI that uniquely identifies the attachment in the system. This URI provides a structured way to reference the document within integrations, APIs, or internal applications. |
Url | String | Contains the URL where the attachment is stored and can be accessed. This URL enables users to retrieve and view the document via web-based interfaces. |
UserName | String | Specifies the login name of the user who added or last modified the attachment. This information supports audit trails, access tracking, and compliance monitoring for document changes. |