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 to manage various resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically for the Role - Update operation, it allows updating an existing role resource by specifying its ID and new properties.
The node supports two modes of operation:
- Automatic mode: You describe your request in natural language, and the node attempts to infer the resource and operation.
- Manual mode: You explicitly select the resource (e.g., Role) and operation (Update).
Typical use cases include:
- Modifying permissions or details of a role within a BookStack instance.
- Automating role updates as part of a workflow that manages user access.
- Integrating role management into larger automation pipelines.
Example: Updating a role's name or description by providing the role ID and new values.
Properties
| Name | Meaning |
|---|---|
| Tool Description | Choose how to determine the resource and operation: either "Set Automatically" or "Set Manually". |
| Request Description | (Shown only if Tool Description is "automatic") A text description of what you want to do; the system uses this to infer resource and operation automatically. Example: "Update role permissions for admin". |
| ID | The unique identifier of the role resource to update. Required for update operations. |
Note: For the Role resource, only the ID property is explicitly defined in the provided snippet for update operations. Other properties like name or description are not shown for Role in the given code, so presumably only the ID is required here or additional fields might be handled dynamically or elsewhere.
Output
The node outputs JSON data representing the response from the BookStack API after performing the update operation on the role. This typically includes the updated role object with its properties as returned by the API.
If multiple input items are processed, the output is an array where each element corresponds to the respective input item, containing either the successful update result or an error message.
No binary data output is indicated for this operation.
Dependencies
- Requires connection to a BookStack instance via its API.
- Needs an API token credential configured in n8n with base URL and authentication tokens.
- The node uses HTTP requests authenticated with a token and secret to communicate with the BookStack API.
Troubleshooting
- Missing or invalid ID: The update operation requires a valid role ID. If omitted or incorrect, the API will return an error.
- Authentication errors: Ensure the API token and base URL credentials are correctly set up and have sufficient permissions.
- Incorrect automatic detection: When using automatic mode, ambiguous or unclear request descriptions may lead to wrong resource or operation inference. Use manual mode to avoid this.
- API endpoint errors: Network issues or incorrect base URLs can cause failures. Verify connectivity and configuration.
- Error messages: Errors from the API are passed through in the output JSON under an
errorfield if "Continue On Fail" is enabled.