BookStackInstall

Overview

This node integrates with the BookStack API, enabling users to manage various BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically for the Tag resource with the Move operation, it allows moving a tag resource within the BookStack system.

The node supports two modes of operation:

• Automatic mode: Users provide a natural language description of their request (e.g., "Move tag X to Y"), and the node attempts to parse and determine the appropriate resource and operation automatically.
• Manual mode: Users explicitly select the resource ("Tag") and operation ("Move") and provide required parameters.

Typical use cases include reorganizing tags by moving them between categories or collections in BookStack, which helps maintain an organized tagging system for content classification.

Properties

For the Tag - Move operation specifically, when manual mode is selected, the user must also provide:

• ID (string): The ID of the tag resource to move.
• Target location parameters (not explicitly shown in the provided snippet but typically required for move operations, e.g., target shelf or book ID).

Output

The node outputs JSON data representing the response from the BookStack API after performing the move operation on the tag resource. This JSON includes details about the moved tag, such as its new location or updated metadata.

No binary data output is indicated for this operation.

Dependencies

• Requires an API key credential for authenticating with the BookStack API.
• The base URL and authentication tokens must be configured in the node credentials.
• The node sends HTTP requests to the BookStack API endpoints corresponding to the selected resource and operation.

Troubleshooting

• Common issues:

  • Incorrect or missing resource ID can cause the API to return errors indicating the resource was not found.
  • Insufficient permissions or invalid API credentials may result in authorization errors.
  • In automatic mode, ambiguous or unclear request descriptions might lead to incorrect resource or operation detection.

• Error messages:

  • Errors returned from the BookStack API are passed through in the JSON output under an error field if "Continue On Fail" is enabled.
  • Typical error messages include "Resource not found," "Unauthorized," or validation errors related to missing required fields.

• Resolutions:

  • Verify that the correct tag ID is provided.
  • Ensure API credentials are valid and have sufficient permissions.
  • When using automatic mode, try to phrase the request description clearly and unambiguously.

Links and References

• BookStack Official API Documentation
• BookStack GitHub Repository

Note: The node supports many other resources and operations beyond Tag-Move, including create, update, delete, copy, get, and list actions for various BookStack entities.