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 Shelf resource with the Delete operation, it allows users to delete a shelf by specifying its unique ID. This is useful in scenarios where you want to automate content management workflows, such as cleaning up unused or obsolete shelves in your BookStack documentation system.
Practical example: Automatically removing a shelf that is no longer needed after archiving its contents elsewhere.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the shelf to delete. This is required to specify which shelf should be removed. |
Output
The node outputs the JSON response from the BookStack API after attempting to delete the specified shelf. Typically, this will be an empty object or a confirmation message indicating successful deletion. There is no binary data output associated with this operation.
Dependencies
- Requires an API key credential for authenticating with the BookStack API.
- The base URL of the BookStack instance must be configured in the credentials.
- The node sends an HTTP DELETE request to the endpoint
/api/shelfs/{id}, where{id}is the shelf ID provided.
Troubleshooting
Common issues:
- Providing an invalid or non-existent shelf ID will result in an error from the API.
- Missing or incorrect API authentication token will cause authorization failures.
- Network connectivity issues to the BookStack server can prevent the request from completing.
Error messages and resolutions:
- 404 Not Found: The shelf ID does not exist. Verify the ID is correct.
- 401 Unauthorized: Authentication failed. Check that the API token and base URL are correctly set in the credentials.
- 400 Bad Request: The request parameters may be malformed. Ensure the ID is properly formatted as a string representing the shelf's ID.