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 - Delete operation, it allows you to delete a role resource by specifying its ID.
Common scenarios where this node is beneficial include automating content management workflows in BookStack, such as programmatically removing outdated or unnecessary roles without manual intervention. For example, an admin could use this node to delete a role that no longer applies to any user or project, helping maintain clean permission structures.
Properties
| Name | Meaning |
|---|---|
| Tool Description | Choose how to determine the resource and operation: - Set Automatically - Set Manually |
| Request Description | (Shown if "Set Automatically" is selected) Describe your request in natural language; the system will try to infer the resource and operation automatically. Example: "Delete role with ID 123". |
| ID | The unique identifier of the role resource to delete. This is required for delete operations. |
Output
The output is an array of JSON objects corresponding to each input item processed. For the delete operation on a role, the json field contains the response from the BookStack API after attempting to delete the specified role. Typically, this will be an empty object or confirmation message indicating successful deletion.
If an error occurs during the deletion, the output JSON will contain an error property with the error message, provided the node is configured to continue on failure.
No binary data output is produced by this node.
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 to be configured in the credentials.
- HTTP requests are made to the BookStack REST API endpoints under
/api/roles/{id}for deleting roles.
Troubleshooting
- Missing or invalid ID: The delete 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 expired, requests will fail with authorization errors. Verify credentials and permissions.
- Resource not found: Attempting to delete a non-existent role ID will result in a 404 error. Confirm the role ID exists before deletion.
- API endpoint issues: Ensure the base URL is correctly set and accessible. Network or URL misconfiguration can cause request failures.
- Continue on Fail: If enabled, errors will be returned in the output JSON instead of stopping execution, allowing partial processing of multiple items.