Viridem icon

Viridem

Interact's with Viridem

Actions77

External Attachments → Get File External Attachment

AI-generated

Overview

This node operation retrieves a file from an external attachment system based on specified parameters such as company ID, external attachment ID, and entity type. It supports different methods for returning the file, either as a direct download or as content. This operation is useful for scenarios where users need to programmatically access and download files related to external attachments in a business or document management context.

Use Case Examples

  1. Downloading an invoice attachment file for a specific company and document anchor entity.
  2. Fetching the content of an expense-related external attachment for processing or display.

Properties

Name Meaning
Company Id The unique identifier of the company to which the external attachment belongs.
Extern Attachment Id The unique identifier of the external attachment file to retrieve.
Entity Type The type of entity the attachment is related to, such as DOCUMENT ANCHOR or EXPENSE.
Method The method to return the file, either as a DOWNLOAD or as CONTENT.
Request Options Additional request options including batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • fileData - The retrieved file data from the external attachment.
  • metadata
    • companyId - The company ID associated with the external attachment.
    • externAttachmentId - The external attachment ID used to fetch the file.
    • entityType - The entity type related to the attachment.
    • method - The method used to return the file (DOWNLOAD or CONTENT).

Dependencies

  • An API key credential for authentication with the external attachment service.

Troubleshooting

  • Ensure that the companyId and externAttachmentId are valid and correspond to existing records; invalid IDs will result in errors or empty responses.
  • If the file is not returned as expected, verify the 'method' parameter to ensure it matches the desired return type (DOWNLOAD or CONTENT).
  • Check network settings such as proxy and SSL options if requests fail due to connectivity or certificate issues.
  • Timeout errors can occur if the server is slow to respond; increase the timeout setting if necessary.

Discussion