Cosense icon

Cosense

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

Actions15

Overview

This node integrates with Cosense (formerly Scrapbox) to manage and retrieve pages within a Cosense project. Specifically, the "Get Pages" operation lists pages in a specified project, allowing users to either fetch all pages or limit the number of results returned.

Common scenarios where this node is beneficial include:

  • Automating retrieval of all pages from a Cosense project for backup or analysis.
  • Fetching a subset of pages when only recent or specific pages are needed.
  • Integrating Cosense page data into workflows for further processing or reporting.

Practical example:

  • A user wants to export all pages from their "my-project" Cosense workspace to analyze content trends. They configure this node to list all pages by setting "Return All" to true.
  • Alternatively, a user may want to preview just the first 50 pages of a project to quickly check recent updates without overwhelming their workflow.

Properties

Name Meaning
Project Name The name of your Cosense/Scrapbox project from which to list pages.
Return All Whether to return all pages in the project (true) or limit the number of results (false).
Limit Maximum number of pages to return if "Return All" is set to false. Minimum value is 1.

Output

The output is an array of JSON objects, each representing a page in the specified Cosense project. Each object contains the page's details as provided by the Cosense API. The exact structure depends on the API response but typically includes page titles and metadata.

No binary data is output by this operation.

Example output snippet (conceptual):

[
  {
    "title": "Page One",
    "id": "123abc",
    "created": "2023-01-01T12:00:00Z",
    "updated": "2023-01-02T15:30:00Z"
  },
  {
    "title": "Page Two",
    "id": "456def",
    "created": "2023-01-03T09:20:00Z",
    "updated": "2023-01-04T11:45:00Z"
  }
]

Dependencies

  • Requires an API key credential for authenticating with the Cosense API.
  • The node uses an internal API client to communicate with Cosense endpoints.
  • No additional external dependencies beyond the configured API authentication.

Troubleshooting

  • Issue: No pages are returned.

    • Cause: The project name might be incorrect or the project has no pages.
    • Resolution: Verify the project name spelling and ensure the project contains pages.

  • Issue: Error related to authentication.

    • Cause: Missing or invalid API key credential.
    • Resolution: Ensure a valid API key credential is configured and linked to the node.

  • Issue: Partial results returned despite setting "Return All" to true.

    • Cause: API rate limits or network issues.
    • Resolution: Check API usage limits and retry. Consider using smaller batch sizes if supported.

  • Error message: "Request failed" or similar.

    • Cause: Network connectivity issues or invalid parameters.
    • Resolution: Confirm network access to Cosense API and validate input parameters.

Links and References

Discussion