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 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 a BookStack instance.
- Automating documentation workflows that require tag information.
- Integrating tag data into other systems or dashboards.
Practical example:
- You want to retrieve the details of a tag with a known ID to display its name and description in an external application or to use it in further automation steps.
Properties
| Name | Meaning |
|---|---|
| Tool Description | Choose how to determine the resource and operation: - Set Automatically - Set Manually |
| Request Description | (Shown only if "Set Automatically" is selected) Describe your request in natural language, e.g., "Get tag with ID 123". The system will try to infer the resource and operation automatically. |
| ID | The unique identifier of the tag resource to retrieve. Required for Get, Update, and Delete operations. |
Output
The node outputs JSON data representing the retrieved tag resource from the BookStack API. The structure corresponds directly to the API response for a tag, typically including fields such as:
id: The tag's unique identifier.name: The name of the tag.- Other metadata fields related to the tag as provided by the BookStack API.
No binary data output is produced by 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 requests with token-based authentication to communicate with the BookStack API.
Troubleshooting
- Missing or invalid ID: If the ID property is empty or incorrect, the API call will fail. Ensure the correct tag ID is provided.
- Authentication errors: Verify that the API token and base URL are correctly set in the credentials.
- Resource not found: If the tag 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 request description, ambiguous or unclear descriptions may lead to incorrect resource or operation detection. In such cases, switch to manual mode and specify the resource and operation explicitly.