Actions71
- Asset Actions
- Attribute Actions
- Block Actions
- Database Actions
- Document Actions
- Markdown Table Actions
- Notebook Actions
- Search Actions
- System Actions
- Tag Actions
System → Export Resources
AI-generatedOverview
This node operation exports specified resources from the SiYuan system as a zip package. It is useful for backing up or transferring selected files or folders from the SiYuan workspace. For example, a user can export specific notebooks or documents by providing their paths, optionally naming the exported package for easier identification.
Use Case Examples
- Exporting a set of documents by specifying their paths to create a backup zip file.
- Exporting a folder containing multiple notes for sharing or archiving.
Properties
| Name | Meaning |
|---|---|
| Paths | Comma-separated list of file or folder paths to export, specifying which resources to include in the export. |
| Additional Options | Optional settings for the export operation, including a custom name for the exported zip package. |
Output
JSON
success- Indicates whether the export operation was successful.exportedFilePath- The file path or URL of the exported zip package containing the selected resources.
Dependencies
- Requires SiYuan API URL and API token credentials for authentication.
Troubleshooting
- Ensure the API URL and token credentials are correctly set; missing or invalid credentials will cause authentication errors.
- Verify that the specified paths exist and are accessible in the SiYuan workspace; invalid paths may cause the export to fail.
- If the export operation fails, check for error messages returned by the SiYuan API for details and adjust parameters accordingly.