Actions31
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 resource with the Get operation, it retrieves detailed information about a specific role by its ID. This is useful in scenarios where you need to fetch role details for access control, auditing, or display purposes within an automation workflow.
Practical examples include:
- Fetching role details to verify permissions before performing actions.
- Retrieving role metadata to synchronize with other systems.
- Displaying role information in reports or dashboards.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the Role resource to retrieve. This is required to specify which role's details to fetch. |
Output
The node outputs JSON data representing the requested Role resource. The structure corresponds directly to the BookStack API response for a single role, typically including fields such as role ID, name, permissions, and other metadata related to the role.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential for authenticating with the BookStack API.
- The base URL of the BookStack instance must be configured in the credentials.
- The node uses HTTP GET requests to the endpoint
/roles/{id}where{id}is the provided Role ID.
Troubleshooting
- Missing or invalid ID: If the ID property is empty or incorrect, the API will likely return a 404 Not Found or similar error. Ensure the ID is correct and corresponds to an existing role.
- Authentication errors: If the API key or token is missing or invalid, authentication will fail. Verify that the API credentials are correctly set up in n8n.
- Network issues: Connectivity problems to the BookStack server can cause request failures. Check network access and the base URL configuration.
- Permission denied: The API user associated with the credentials might lack permission to view roles. Confirm appropriate permissions are granted.
Links and References
- BookStack API Documentation
- BookStack Roles API Endpoint (for detailed response schema and usage)