Cosense icon

Cosense

Read and write pages in Cosense (formerly Scrapbox)
Join our community

Actions15

Overview

This node enables exporting and importing entire project data within Cosense (formerly Scrapbox). It supports two main operations:

  • Export Project: Retrieves all pages and associated data from a specified project, allowing users to back up or migrate their project content.
  • Import Project: Imports complete project data into a specified project, facilitating restoration or transfer of project contents.

Typical use cases include backing up a project before major changes, migrating projects between environments, or restoring project data from a backup.

Properties

Name Meaning
Operation Choose between "Export Project" (export entire project data) or "Import Project" (import project data)
Project Name The name of the Cosense/Scrapbox project to export from or import into
Project Data (Only for Import Project) JSON object containing the complete project data to be imported

Output

The node outputs JSON data representing the project content:

  • For Export Project, the output is an array of page objects, each containing the data of individual pages in the project.
  • For Import Project, the output reflects the result of the import operation, typically confirming success or providing details about the imported pages.

No binary data output is involved.

Dependencies

  • Requires access to the Cosense API via an API key credential configured in n8n.
  • The node uses the Cosense API client internally to perform export and import operations.
  • Network connectivity to the Cosense service is necessary.

Troubleshooting

  • Common Issues:

    • Incorrect project name may lead to errors or empty results.
    • Malformed or incomplete project data JSON during import can cause failures.
    • Insufficient permissions or invalid API credentials will prevent successful API calls.

  • Error Messages:

    • Errors returned from the Cosense API are propagated. Typical messages might indicate authentication failure, project not found, or invalid data format.
    • To resolve, verify the project name, ensure the API key is valid and has required permissions, and confirm that the project data JSON is correctly structured.

Links and References

Discussion