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 Shelves, Books, Pages, Chapters, Users, Roles, Attachments, and Tags. The "Shelf" resource with the "Get" operation enables retrieving detailed information about a specific shelf by its ID.
Common scenarios for this node include:
- Fetching metadata or details of a particular shelf in a BookStack instance.
- Automating documentation workflows where shelf data is needed for further processing.
- Integrating BookStack content management into broader automation pipelines.
For example, you might use this node to get the details of a shelf that organizes related books, then use that data to generate reports or trigger notifications.
Properties
| Name | Meaning |
|---|---|
| Tool Description | Choose how to determine the resource and operation: - Set Automatically - Set Manually |
| Request Description | (Shown if "Set Automatically" is chosen) Describe your request in natural language; the system will infer the resource and operation automatically. Example: "Get shelf with ID 123". |
| ID | (Required for Get operation) The unique identifier of the shelf resource to retrieve. |
Output
The node outputs JSON data representing the requested shelf resource from the BookStack API. This JSON includes all properties returned by the API for a shelf, such as its name, description, creation date, and any other metadata provided by BookStack.
No binary data output is produced by this operation.
Example output structure (simplified):
{
"id": 1,
"name": "Sample Shelf",
"description": "A collection of related books",
"created_at": "2023-01-01T12:00:00Z",
"updated_at": "2023-01-02T12:00:00Z",
...
}
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.
- HTTP requests are made to the BookStack REST API endpoints under
/api/shelfs/{id}.
Troubleshooting
- Missing or invalid ID: The "ID" property is required for the Get operation. If omitted or incorrect, the API will return an error indicating the resource was not found.
- Authentication errors: Ensure the API token and base URL are correctly set in the credentials. Authentication failures will result in HTTP 401 or 403 errors.
- Resource not found: If the specified shelf ID does not exist, the API returns a 404 error.
- Automatic mode parsing issues: When using "Set Automatically" with a natural language request description, ambiguous or incomplete descriptions may cause the node to select the wrong resource or operation. In such cases, switch to manual mode and specify parameters explicitly.