Actions40
- Role Actions
- Page Actions
- Chapter Actions
- Book Actions
- Shelf Actions
- User Actions
- Attachment Actions
- Tag Actions
Overview
This node integrates with the BookStack API, allowing users to manage various BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically for the Attachment - Update operation, it enables updating an existing attachment resource by its ID.
The node supports two modes of operation selection:
- Automatic mode: Users describe their request in natural language, and the node attempts to infer the appropriate resource and operation.
- Manual mode: Users explicitly select the resource and operation.
Typical use cases for the Attachment Update operation include modifying metadata or properties of an existing attachment file within a BookStack instance, such as changing its name or description.
Practical example:
- Updating the details of an attachment linked to a page or chapter after uploading a new version or correcting its metadata.
Properties
| Name | Meaning |
|---|---|
| Tool Description | Choose how to determine the resource and operation: "Set Automatically" or "Set Manually". |
| Request Description | (Shown only if "Set Automatically" is selected) A text description of what you want to do; the system uses this to infer resource and operation automatically. |
| ID | The unique identifier of the attachment resource to update. Required for update operations. |
Output
The node outputs JSON data representing the updated attachment resource as returned by the BookStack API. This typically includes fields such as the attachment's ID, name, URL, associated entity, and other metadata.
No binary data output is indicated for this operation.
Dependencies
- Requires connection to a BookStack instance via its API.
- Needs an API authentication token credential configured in n8n with:
- Base URL of the BookStack API.
- Token and token secret for authorization.
- The node sends HTTP requests authenticated with these credentials.
Troubleshooting
Common issues:
- Incorrect or missing attachment ID will cause the update to fail.
- Insufficient permissions or invalid API tokens may result in authorization errors.
- Malformed input data or missing required fields can cause API validation errors.
Error messages:
- Errors from the BookStack API are passed through; typical messages include "Resource not found" if the ID does not exist, or "Unauthorized" if credentials are invalid.
- If using automatic mode, ambiguous or unclear request descriptions might lead to incorrect resource/operation detection.
Resolutions:
- Verify the attachment ID is correct and exists.
- Ensure API credentials are valid and have sufficient permissions.
- Provide clear and specific request descriptions when using automatic mode.
- Use manual mode to explicitly set resource and operation if automatic detection fails.