BookStack icon

BookStack

Consume BookStack API

Actions40

Overview

This node integrates with the BookStack API, allowing users to manage various BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically, for the Attachment - Get operation, it retrieves a single attachment resource by its ID.

Common scenarios where this node is beneficial include:

  • Fetching metadata or details about a specific attachment stored in BookStack.
  • Automating workflows that require accessing attachment information for documentation or content management.
  • Integrating BookStack attachments into other systems or processes by retrieving their data programmatically.

For example, you might use this node to get an attachment's details before downloading or processing it further in your workflow.

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; the system selects resource and operation automatically based on this text. Example: "Get attachment with ID 123".
ID The unique identifier of the attachment resource to retrieve. Required for Get operation.

Output

The node outputs JSON data representing the retrieved attachment resource from BookStack. This JSON contains all the fields returned by the BookStack API for an attachment, such as its ID, name, URL, size, and any other metadata provided by the API.

If the node supports binary data output for attachments (e.g., the actual file content), it is not explicitly shown in the code snippet. Therefore, the output primarily consists of JSON metadata about the attachment.

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 uses HTTP requests to communicate with the BookStack REST API endpoints.

Troubleshooting

  • Missing or invalid ID: The "ID" property is required for the Get operation. If omitted or incorrect, the API will likely return an error indicating the resource was not found.
  • Authentication errors: Ensure the API token and base URL are correctly set in the credentials. Authentication failures will prevent successful API calls.
  • Incorrect resource or operation selection: When using "Set Manually," selecting the wrong resource or operation may cause unexpected results or errors.
  • Automatic mode parsing issues: If the "Request Description" does not clearly specify the intended resource and operation, the automatic detection logic might select the wrong action. In such cases, switch to manual mode or clarify the description.

Links and References

Discussion