Actions22
Overview
This node interacts with the BookStack API to retrieve multiple Shelf resources based on user-defined criteria. It is designed to fetch a list of shelves, supporting sorting, filtering, pagination (count and offset), and flexible query parameters.
Common scenarios where this node is beneficial include:
- Retrieving an organized list of shelves for display or further processing.
- Filtering shelves by specific fields such as name or creation date.
- Paginating through large sets of shelves in a controlled manner.
- Sorting shelves by various attributes in ascending or descending order.
Practical example: A user wants to get up to 100 shelves sorted by their creation date in descending order, filtered to only include shelves whose name contains "Project".
Properties
| Name | Meaning |
|---|---|
| Sort By | Field to sort the results by (e.g., name, created_at, updated_at). |
| Sort Direction | Direction of sorting: Ascending or Descending. |
| Filters | One or more filters to apply on shelf fields. Each filter includes: |
| - Field: The shelf 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 shelf results to return (minimum 1, maximum 500). Defaults to 100. |
| Offset | Number of shelf results to skip before starting to return results (minimum 0). Defaults to 0. |
Output
The output is an array of JSON objects, each representing a Shelf resource retrieved from the BookStack API. Each object contains shelf properties such as name, description, associated books, tags, and other metadata as provided by the API.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating requests to the BookStack API.
- The node uses HTTP GET requests to the
/shelvesendpoint of the BookStack API. - No additional external dependencies beyond the configured API authentication.
Troubleshooting
Common issues:
- Incorrect or missing API credentials will cause authentication failures.
- Using invalid field names in filters or sort options may result in API errors or empty results.
- Requesting a count above the maximum allowed (500) will be rejected.
- Providing malformed filter values or unsupported operations can cause errors.
Error messages:
- Authentication errors typically indicate invalid or missing API keys; verify credentials.
- Validation errors about required parameters suggest missing mandatory inputs like
countoroffset. - API response errors may indicate invalid filter fields or unsupported sort fields; check property values carefully.