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 - Get operation, it retrieves detailed information about a specific role by its ID.
Common scenarios where this node is beneficial include:
- Fetching role details to understand permissions or access levels assigned within a BookStack instance.
- Automating workflows that require role-based data retrieval for auditing or reporting.
- Integrating role information into other systems or dashboards.
Practical example:
- You want to retrieve the details of a role with a known ID to verify its permissions before assigning it to a user in an automated onboarding process.
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: "Get role with ID 5". |
| ID | The unique identifier of the role to retrieve. Required for the Get operation. |
Output
The output is a JSON object representing the retrieved role resource from the BookStack API. It typically includes fields such as the role's ID, name, permissions, and other metadata defined by the API.
Example structure (simplified):
{
"id": 5,
"name": "Editor",
"permissions": [
// permission details here
],
// additional role properties
}
No binary data output is produced by this operation.
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.
- Network access to the BookStack API endpoint is necessary.
Troubleshooting
- Missing or invalid ID: If the ID property is not provided or incorrect, the API call will fail. Ensure the correct role ID is specified.
- Authentication errors: Verify that the API key/token credentials are correctly set up and have sufficient permissions to read role data.
- Resource not found: If the role ID does not exist, the API will return an error indicating the resource was not found.
- Automatic detection issues: When using automatic mode with a natural language description, ambiguous or unclear requests may lead to incorrect resource or operation selection. In such cases, switch to manual mode and specify the resource and operation explicitly.