Actions31
Overview
This node integrates with the BookStack API to retrieve information about a specific Shelf resource by its ID. It is useful when you want to fetch detailed data about a particular shelf in your BookStack instance, such as its name, description, and associated metadata.
Practical examples include:
- Automating documentation workflows by retrieving shelf details to display or process elsewhere.
- Synchronizing shelf information with other systems or databases.
- Triggering further actions based on shelf properties in an automation pipeline.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the Shelf resource to retrieve. This is required for the "Get" operation. |
Output
The node outputs JSON data representing the Shelf resource retrieved from the BookStack API. The structure corresponds to the API's response for a single shelf, typically including fields like the shelf's ID, name, description, creation date, and any other metadata provided by BookStack.
No binary data output is produced by 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 uses HTTP GET requests to the endpoint
/api/shelfs/{id}where{id}is the Shelf ID.
Troubleshooting
- Missing or invalid ID: If the ID property is empty or incorrect, the API will return an error indicating the resource was not found. Ensure the ID is correct and exists in your BookStack instance.
- Authentication errors: If the API key or token is missing or invalid, authentication will fail. Verify that the API credentials are correctly set up in n8n.
- Network issues: Connectivity problems to the BookStack server will cause request failures. Check network access and the base URL configuration.
- API changes: If the BookStack API changes, the node might fail to retrieve data properly. Keep the node and API version compatible.