BookStack icon

BookStack

Consume BookStack API

Actions40

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 - 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 role audits or synchronizations with external systems.
  • Integrating role data into workflows that require conditional logic based on user roles.

Practical example:

  • You want to retrieve the details of a role with ID 5 to check its permissions before assigning it to a new user in your system.

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 what you want to do, e.g., "Get role info"
ID The unique identifier of the role to retrieve (required for get operation)

Output

The output is a JSON object representing the retrieved role resource from the BookStack API. It contains all the properties of the role, such as its ID, name, permissions, and any other metadata provided by the API.

Example output structure (simplified):

{
  "id": 5,
  "name": "Editor",
  "permissions": [
    // permission details here
  ],
  // additional role fields...
}

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 to be configured in the credentials.
  • HTTP requests are made to endpoints like /roles/{id} using GET method.

Troubleshooting

  • Missing or invalid ID: If the ID property is empty or incorrect, the API will return an error indicating the resource was not found. Ensure the correct role ID is provided.
  • Authentication errors: If the API key or token is invalid or missing, the request will fail with an authorization error. Verify credentials configuration.
  • Network issues: Connectivity problems to the BookStack server will cause request failures. Check network access and base URL correctness.
  • Automatic mode parsing errors: When using automatic tool description mode, ambiguous or unclear descriptions may lead to incorrect resource or operation selection. Use manual mode for precise control.

Links and References

Discussion