Actions22
Overview
This node interacts with the BookStack platform to manage "Chapter" resources, specifically supporting the operation to retrieve multiple chapters ("Get Many"). It allows users to fetch a list of chapters with flexible sorting, filtering, pagination (count and offset), making it useful for scenarios where you want to display or process multiple chapters from a BookStack instance.
Practical examples include:
- Retrieving all chapters sorted by creation date in descending order.
- Fetching chapters filtered by a specific field value, such as chapters belonging to a particular book.
- Paginating through large sets of chapters by specifying count and offset parameters.
Properties
| Name | Meaning |
|---|---|
| Sort By | Field to sort the results by (e.g., name, created_at, updated_at). |
| Sort Direction | Direction of sorting: either Ascending or Descending. |
| Filters | One or more filters to apply on fields. Each filter includes: |
| - Field: The chapter field to filter on. | |
- Operation: Comparison operation (Equals, Greater Than, Greater Than or Equals, Less Than, Less Than or Equals, Like, Not Equals). |
|
| - Value: The value to compare against. | |
| Count | Maximum number of chapter results to return (minimum 1, maximum 500). Defaults to 100. |
| Offset | Number of results to skip before starting to collect the output set. Defaults to 0. |
Output
The node outputs an array of JSON objects representing chapters retrieved from BookStack. Each object corresponds to a single chapter resource with its properties as returned by the BookStack API.
The output structure is:
[
{
"json": {
// Chapter properties such as id, name, description, book_id, tags, etc.
},
"pairedItem": {
"item": <index_of_input_item>
}
},
...
]
No binary data output is produced by this operation.
Dependencies
- Requires a valid connection to a BookStack instance via an API key credential configured in n8n.
- Uses the BookStack REST API endpoints for chapters.
- No additional external services are required beyond the BookStack API.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication errors.
- Using unsupported or misspelled field names in filters or sort fields may result in API errors or empty results.
- Requesting a count above 500 will be rejected due to API limits.
- Providing invalid filter operations or values can cause request failures.
Error messages:
- Errors thrown by the BookStack API are surfaced as node execution errors with descriptive messages.
- If no chapters match the filters, the node returns an empty array without error.
- Network or connectivity issues will cause request failures; verify network access and API endpoint correctness.