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 to manage various BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically for the Role resource with the Update operation, it allows updating an existing role by specifying its ID and providing updated data.
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 specify the resource and operation.
Typical use cases include automating role management within a BookStack instance, such as modifying permissions or role details programmatically as part of a workflow.
Example: Updating a role's properties by providing its ID and new attributes to keep user permissions up to date.
Properties
| Name | Meaning |
|---|---|
| Tool Description | Choose how to determine the resource and operation: - Set Automatically - Set Manually |
| Request Description | (Shown only if "Set Automatically" is selected) Describe your request in natural language; the system will try to select the appropriate resource and operation automatically. Example: "Update role with ID 5 to have new permissions." |
| 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.
Dependencies
- Requires an API key credential for authenticating with the BookStack API.
- The base URL and authentication tokens must be configured in the node credentials.
- The node uses HTTP requests to communicate with 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 indicating the resource was not found.
- Authentication errors: Ensure that the API token and base URL are correctly set in the credentials. Authentication failures will prevent any API calls.
- Incorrect property values: Providing invalid or incomplete data for the update may cause the API to reject the request.
- Automatic mode misinterpretation: When using automatic mode, ambiguous or unclear descriptions might lead to wrong resource or operation detection. In such cases, switch to manual mode and specify parameters explicitly.