Actions31
Overview
This node integrates with the BookStack API to manage various resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically, for the Attachment - Update operation, it allows updating an existing attachment resource by its ID. This is useful when you need to modify metadata or properties of an attachment already stored in BookStack.
Common scenarios include:
- Correcting or updating the name or description of an attachment.
- Adjusting attachment details without needing to delete and re-upload.
- Automating updates to attachments as part of a content management workflow.
Example: Updating the name or other editable fields of an attachment identified by its unique ID.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the attachment resource to update. This is required to specify which attachment will be modified. |
Note: Although only the "ID" property is explicitly defined for the Attachment Update operation here, the node supports additional fields like "name" and "description" for some resources (not shown in the provided input properties). For attachments, typically the ID is mandatory to identify the resource.
Output
The node outputs JSON data representing the updated attachment resource as returned by the BookStack API after the update operation. This JSON includes all relevant fields of the attachment, reflecting the new state post-update.
No binary data output is indicated for this operation.
Dependencies
- Requires connection to a BookStack instance via its REST API.
- Needs an API token credential consisting of a base URL and authentication tokens.
- The node uses HTTP PUT requests to update resources at endpoints structured as
/attachments/{id}.
Troubleshooting
- Missing or invalid ID: The update operation requires a valid attachment ID. If omitted or incorrect, the API will return an error indicating the resource was not found.
- Authentication errors: Ensure that the API token credentials are correctly configured and have sufficient permissions to update attachments.
- Invalid field values: If additional fields are sent with invalid formats or types, the API may reject the request.
- Network issues: Connectivity problems with the BookStack server will cause request failures.
To resolve these:
- Double-check the attachment ID value.
- Verify API credentials and permissions.
- Confirm the BookStack server URL is reachable.
- Review any error messages returned by the API for specific guidance.