Overview

This node operation lists all documents within a specified notebook in the SiYuan workspace. It is useful for workflows that need to retrieve and process documents organized under a particular notebook, such as content management, document indexing, or automation of document-related tasks.

Use Case Examples

1. Retrieve all documents in a specific notebook to generate a summary report.
2. List documents in a notebook to automate batch processing or exporting of document data.

Properties

Output

JSON

• id - The unique identifier of each document in the notebook.
• title - The title or name of each document.
• createdAt - Timestamp when the document was created.
• updatedAt - Timestamp when the document was last updated.
• notebookId - The ID of the notebook to which the document belongs.

Dependencies

• Requires SiYuan API URL and API token credentials for authentication.

Troubleshooting

• Ensure the Notebook ID is correctly provided and exists in the SiYuan workspace.
• Verify that the API URL and token credentials are valid and have sufficient permissions.
• Common error: 'SiYuan API URL and Token are required.' indicates missing or invalid credentials.
• Unsupported resource or operation errors occur if the resource or operation parameters are incorrect.