Librus icon

Librus

Read data from Librus Synergia (unofficial)
Join our community

Actions105

Overview

This node interacts with a school-related API to perform various operations related to messages, homework, absences, calendar events, and user info. Specifically, for the Messages - Get Attachment operation, it retrieves a file attachment from a message by specifying its path.

Typical use cases include:

  • Downloading attachments sent via the messaging system in a school platform.
  • Automating retrieval of files such as homework assignments, announcements, or other shared documents.
  • Integrating message attachments into workflows for further processing or storage.

For example, you might use this node to automatically download all attachments received within a certain date range or to fetch a specific file attached to a message for archival.

Properties

Name Meaning
From Optional start date filter (format: YYYY-MM-DD) to limit data retrieval by date.
To Optional end date filter (format: YYYY-MM-DD) to limit data retrieval by date.
Custom method name Advanced option to override the underlying API method called (e.g., getMarks).
Attachment Path Required. The full path to the attachment file to retrieve.
Binary Property Name of the binary property on the output item where the downloaded file will be stored.

Note: The "From" and "To" properties are generally used for filtering lists of messages or homework but are available on the resource level.

Output

The output contains one or more items depending on the operation:

  • For Get Attachment, the node outputs a single item with:
    • A json field containing { path: <attachmentPath> }.
    • A binary field containing the file data:
      • The binary property name is configurable (default "data").
      • The binary data is base64 encoded.
      • The MIME type is set to "application/octet-stream".
      • The filename is extracted from the last segment of the attachment path.

This allows downstream nodes to access the raw file content for saving, processing, or forwarding.

Dependencies

  • Requires an API key credential with login and password to authenticate against the external school platform API.
  • Uses an internal client wrapper library to communicate with the API.
  • No additional environment variables are explicitly required beyond the API credentials.

Troubleshooting

  • No supported method found error: If the node throws an error about no supported method found for the resource-operation combination, verify that the operation name matches exactly and that the custom method name (if used) is valid.
  • Attachment not found or empty response: Ensure the attachment path is correct and accessible. Paths must be exact and correspond to existing files.
  • Authentication errors: Confirm that the provided API credentials are valid and have sufficient permissions.
  • Date filters ignored: The "From" and "To" parameters only apply to list operations, not to fetching individual attachments.

Links and References

  • No direct external links are embedded in the code, but users should refer to their school platform's API documentation for details on message and attachment paths.
  • General n8n documentation on handling binary data: https://docs.n8n.io/nodes/creating-nodes/binary-data/

Discussion