Actions31
Overview
This node integrates with the BookStack API to manage "Shelf" resources, specifically allowing you to update an existing Shelf. It is useful when you want to programmatically modify the properties of a Shelf in your BookStack instance, such as changing its name or description.
Practical examples include:
- Renaming a Shelf to better reflect its contents.
- Updating the description of a Shelf to provide more context or details.
- Automating bulk updates of Shelves based on external data sources.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the Shelf resource you want to update. |
| Name | The new name for the Shelf. This is required when updating. |
| Description | An optional description for the Shelf to provide additional information or context. |
Output
The node outputs JSON data representing the updated Shelf resource as returned by the BookStack API. This typically includes fields such as the Shelf's ID, name, description, and other metadata reflecting the current state after the update.
No binary data output is involved.
Dependencies
- Requires connection to a BookStack instance via its API.
- Needs an API authentication token credential configured in n8n with appropriate permissions to update Shelf resources.
- The base URL of the BookStack API and the authentication token must be set in the node credentials.
Troubleshooting
Common issues:
- Invalid or missing Shelf ID will cause the update to fail.
- Insufficient permissions or invalid API token can result in authorization errors.
- Providing empty or invalid values for required fields like Name may cause validation errors.
Error messages and resolutions:
- 404 Not Found: The specified Shelf ID does not exist. Verify the ID is correct.
- 401 Unauthorized: Authentication failed. Check that the API token is valid and has update permissions.
- 400 Bad Request: Required fields are missing or invalid. Ensure the Name field is provided and correctly formatted.