OnlyOffice

Interact with OnlyOffice files and folders
Join our community

Actions12

Overview

This node integrates with OnlyOffice to manage files and folders within an OnlyOffice environment. Specifically, the Folder - List operation retrieves the contents of a specified folder, including both subfolders and files.

Common scenarios where this node is useful include:

  • Automating document management workflows by listing documents in a particular folder.
  • Synchronizing OnlyOffice folder contents with other systems.
  • Building dashboards or reports that display folder contents dynamically.

For example, you can use this node to list all files and subfolders inside your "My Documents" folder (@my) or a shared "Common Documents" folder (@common), then process or route those items further in your workflow.

Properties

Name Meaning
Folder ID ID of the folder to list contents from. Use @my for My Documents, @common for Common Documents.

Output

The output is an array of JSON objects representing the contents of the specified folder. Each item corresponds to either a folder or a file and includes metadata as returned by the OnlyOffice API.

The structure typically contains two types of entries merged into one list:

  • Folders: Objects representing subfolders inside the specified folder.
  • Files: Objects representing files inside the specified folder.

The exact fields depend on the OnlyOffice API response but generally include identifiers, titles, and other relevant metadata.

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for OnlyOffice with access to the OnlyOffice API.
  • The node uses the base URL configured in the credentials to make authenticated HTTP requests to the OnlyOffice API endpoints.
  • No additional external dependencies are required beyond the OnlyOffice API access.

Troubleshooting

  • Common issues:

    • Invalid or missing Folder ID: Ensure the Folder ID parameter is correctly set (e.g., @my, @common, or a valid folder UUID).
    • Authentication errors: Verify that the OnlyOffice API credentials are correctly configured and have sufficient permissions.
    • Network or API endpoint errors: Confirm the base URL is correct and the OnlyOffice server is reachable.

  • Error messages:

    • "Unknown folder operation: list": This would indicate an internal misconfiguration; ensure the operation parameter is set to "list".
    • HTTP errors from the API (e.g., 401 Unauthorized, 404 Not Found): Check credentials and folder existence.
    • If the node throws an error about request failure, inspect the API response for details and verify network connectivity.

Links and References

Discussion