Actions40
- Book Actions
- Page Actions
- Chapter Actions
- Shelf Actions
- User Actions
- Role Actions
- Attachment Actions
- Tag Actions
Overview
This node integrates with the BookStack API, specifically allowing users to interact with various BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. The "Get Many" operation for the "Shelf" resource retrieves multiple shelf records from the BookStack system.
Common scenarios where this node is beneficial include:
- Fetching a list of all shelves (collections of books) in a BookStack instance.
- Automating documentation workflows by retrieving shelf data for further processing or reporting.
- Integrating BookStack shelf information into other systems or dashboards.
For example, a user might want to list all shelves to display them in an external portal or to synchronize shelf metadata with another content management system.
Properties
| Name | Meaning |
|---|---|
| Tool Description | Choose how to determine the resource and operation. Options: "Set Automatically", "Set Manually". |
| Request Description | When "Tool Description" is set to "Set Automatically", describe what you want to do (e.g., "List all shelves"). This text guides the node to select the appropriate resource and operation automatically. |
Note: For the "Get Many" operation on the "Shelf" resource, typically the "Tool Description" would be set to "Set Manually" and the resource set to "Shelf" with operation "Get Many".
Output
The node outputs JSON data representing the response from the BookStack API for the requested shelves. The structure corresponds to the API's response format, typically including an array of shelf objects under a root property (commonly data).
Each shelf object may contain fields such as:
- Shelf ID
- Name
- Description
- Other metadata related to the shelf
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating with the BookStack API.
- The node expects the base URL of the BookStack instance and authentication tokens to be configured in the credentials.
- Uses HTTP requests with token-based authorization headers.
Troubleshooting
Common Issues:
- Incorrect or missing API credentials will cause authentication failures.
- Providing an invalid base URL or network issues can lead to connection errors.
- If the "Tool Description" is set to automatic but the request description is unclear or ambiguous, the node might select an unintended resource or operation.
Error Messages:
- Authentication errors usually indicate invalid or expired tokens; verify and update credentials.
- HTTP 404 errors suggest the requested resource path is incorrect; ensure the resource and operation are properly selected.
- Parsing errors may occur if the API response format changes; check for updates in the BookStack API.