Actions56
- Book Actions
- Page Actions
- Chapter Actions
- Shelf Actions
- User Actions
- Role Actions
- Attachment Actions
- Tag Actions
Overview
This node integrates with the BookStack API, enabling users to manage BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically for the User resource with the Move operation, it allows relocating a user resource within the system.
The node supports two modes of operation:
- Automatic mode: Users describe their request in natural language, and the node attempts to parse and determine the appropriate resource and operation.
- Manual mode: Users explicitly select the resource and operation from dropdowns and provide required parameters.
Typical use cases include moving a user to a different group or organizational unit within BookStack, or more generally managing user assignments programmatically. For example, you might move a user to a new role or department by specifying the target location.
Properties
| Name | Meaning |
|---|---|
| Tool Description | Choose how to determine the resource and operation: "Set Automatically" (natural language input) or "Set Manually" (explicit selection). |
| Request Description | When "Set Automatically" is selected, describe your request in natural language (e.g., "Move user John Doe to admin group"). The system will parse this to select resource and operation automatically. |
Note: Since the Resource is fixed to User and Operation to Move, other properties like id (user ID) and target location parameters are handled internally or via the description in automatic mode.
Output
The node outputs an array of JSON objects corresponding to each input item processed. Each output object contains the response from the BookStack API after performing the move operation on the user resource.
The structure of the JSON output depends on the BookStack API's response for the move action but typically includes confirmation details about the moved user or any relevant metadata.
No binary data output is produced by this node.
Dependencies
- Requires connection credentials to the BookStack API, including:
- Base URL of the BookStack instance.
- An API token and secret for authentication.
- The node uses HTTP requests authenticated with these credentials to interact with the BookStack REST API.
Troubleshooting
Common issues:
- Incorrect or missing user ID when performing the move operation can cause errors.
- Insufficient permissions or invalid API tokens may result in authorization failures.
- Malformed natural language descriptions in automatic mode might lead to incorrect resource/operation detection.
Error messages:
- API errors returned from BookStack (e.g., 404 Not Found if user ID does not exist).
- Authentication errors if credentials are invalid.
- Parsing errors if the natural language request cannot be interpreted.
Resolutions:
- Verify that the user ID provided exists and is correct.
- Ensure API credentials are valid and have sufficient permissions.
- Use manual mode if automatic parsing fails or is unreliable.
- Provide clear and concise descriptions in automatic mode to improve detection accuracy.