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 Tag resource with the Get operation, it retrieves detailed information about a single tag by its ID.
Common scenarios where this node is beneficial include:
- Fetching metadata or details of a specific tag in BookStack to display or process within an automation workflow.
- Integrating BookStack tagging data into other systems or reports.
- Using tag information to conditionally route or filter data in workflows.
Practical example:
- You have a workflow that triggers when a document is updated, and you want to fetch the associated tag details to decide further processing steps based on tag properties.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the Tag resource to retrieve. This is required for the Get operation. |
Output
The node outputs JSON data representing the requested Tag resource. The structure corresponds directly to the BookStack API response for a single tag, typically including fields such as the tag's ID, name, description, and any other metadata provided by the API.
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
/api/tags/{id}to fetch tag details.
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 ID is correct and exists in BookStack.
- Authentication errors: If the API key or token is missing or invalid, the request will fail with an authentication error. Verify that the API credentials are correctly set up.
- Network or connectivity issues: Failures to reach the BookStack server may occur due to network problems or incorrect base URL configuration.
- Permission issues: The API user must have sufficient permissions to read tag data; otherwise, access will be denied.