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 to manage roles and other resources such as books, pages, chapters, shelves, users, attachments, and tags. Specifically for the Role - Update operation, it allows updating an existing role resource by specifying its ID and new properties.
Common scenarios where this node is beneficial include automating content management workflows in BookStack, such as programmatically updating user roles or permissions based on external triggers or data changes. For example, you could update a role's details when a user's status changes in another system, or modify role permissions as part of an onboarding process.
Properties
| Name | Meaning |
|---|---|
| Tool Description | Choose how to determine the resource and operation: either "Set Automatically" or "Set Manually". |
| Request Description | (Shown if "Set Automatically") A text description of what you want to do; the system uses this to infer the resource and operation automatically. Example: "Update role permissions for admin". |
| ID | The unique identifier of the role resource to update. Required for update operations. |
Output
The node outputs JSON data representing the response from the BookStack API after performing the update operation on the role resource. This typically includes the updated role object with its properties as returned by the API.
No binary data output is involved in this operation.
Example output structure (simplified):
{
"id": 123,
"name": "Updated Role Name",
"permissions": [...],
...
}
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 configured in the credentials.
- HTTP requests are made to the BookStack REST API endpoints.
Troubleshooting
- Missing or invalid ID: The update operation requires a valid role ID. If omitted or incorrect, the API will return an error. Ensure the ID corresponds to an existing role.
- Authentication errors: If the API key or token is invalid or missing, requests will fail with authorization errors. Verify credentials configuration.
- Incorrect property values: Providing invalid or unsupported fields in the update payload may cause API errors. Use only supported fields for roles.
- Automatic mode parsing issues: When using "Set Automatically" with a request description, ambiguous or unclear descriptions might lead to wrong resource or operation inference. In such cases, switch to manual mode.