Actions40
- Role Actions
- Page Actions
- Chapter Actions
- Book Actions
- Shelf Actions
- User Actions
- Attachment Actions
- Tag Actions
Overview
This node integrates with the BookStack API, a platform for creating and managing documentation content such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically, the Shelf - Get operation retrieves detailed information about a single shelf resource by its ID.
Common scenarios where this node is beneficial include:
- Fetching metadata or details of a specific shelf in your BookStack instance to display or process further.
- Automating workflows that require accessing shelf information, such as syncing shelf data with other systems or generating reports.
- Integrating shelf data retrieval into larger automation pipelines involving documentation management.
Example: You want to get the details of a shelf with ID 123 to check its name and description before updating or displaying it elsewhere.
Properties
| Name | Meaning |
|---|---|
| Tool Description | Choose how to determine the resource and operation: - Set Automatically - Set Manually |
| Request Description | (Shown only if "Set Automatically" is selected) Describe what you want to do in natural language; the system will try to infer the resource and operation automatically. Example: "Get shelf with ID 123". |
| ID | The unique identifier of the shelf resource to retrieve. Required for the Get operation. |
Output
The output is a JSON object representing the shelf resource retrieved from the BookStack API. It contains all standard shelf fields as returned by the API, typically including:
id: The shelf's unique identifier.name: The name of the shelf.description: A textual description of the shelf.- Other metadata fields related to the shelf.
The node does not output binary data for 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 requests with token-based authentication to communicate with the BookStack API.
Troubleshooting
- Missing or invalid ID: The Get operation requires a valid shelf ID. If omitted or incorrect, the API will return an error. Ensure the ID is correct and provided.
- Authentication errors: If the API key or token is invalid or missing, the request will fail. Verify that the API credentials are correctly set up.
- Network or connectivity issues: Ensure the BookStack server is reachable from n8n and that the base URL is correct.
- Automatic detection inaccuracies: When using "Set Automatically" mode with a natural language description, the node attempts to infer the operation and resource. Ambiguous or unclear descriptions may lead to incorrect inference. In such cases, switch to "Set Manually" and specify the resource and operation explicitly.