Actions71
- Asset Actions
- Attribute Actions
- Block Actions
- Database Actions
- Document Actions
- Markdown Table Actions
- Notebook Actions
- Search Actions
- System Actions
- Tag Actions
Notebook → Get Configuration
AI-generatedOverview
This node operation retrieves the configuration details of a specified notebook in the SiYuan workspace. It is useful for scenarios where users need to access or verify the settings and metadata of a particular notebook by providing its unique ID. For example, it can be used to fetch configuration data before performing updates or to audit notebook settings programmatically.
Use Case Examples
- Fetch configuration of a notebook by its ID to check its current settings.
- Retrieve notebook configuration to use in automated workflows for documentation or reporting.
Properties
| Name | Meaning |
|---|---|
| Notebook ID | The unique ID of the notebook to retrieve configuration for. |
Output
JSON
notebookConfiguration- The configuration details of the specified notebook, including its settings and metadata.
Dependencies
- Requires an API URL and API token credential for authenticating with the SiYuan API.
Troubleshooting
- Ensure the Notebook ID is correctly provided and exists in the SiYuan workspace.
- Verify that the API URL and API token credentials are correctly set and valid.
- 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 or not implemented.