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, allowing users to manage BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically for the Page - Get operation, it retrieves detailed information about a single page resource by its ID.
Common scenarios where this node is beneficial include:
- Fetching content of a specific documentation page stored in BookStack.
- Retrieving metadata or HTML content of a page for further processing or display.
- Integrating BookStack page data into other workflows or systems.
Practical example:
- You want to automatically pull the content of a particular page from your BookStack instance to include it in a report or send it via email.
Properties
| Name | Meaning |
|---|---|
| Tool Description | Choose how to determine the resource and operation: either "Set Automatically" or "Set Manually". |
| Request Description | (Shown if "Tool Description" is "Set Automatically") Describe what you want to do; the system will auto-select resource and operation. Example: "Get page with ID 123". |
| ID | The unique identifier of the page resource to retrieve. Required for "get", "update", and "delete" operations. |
Output
The output is a JSON object representing the retrieved page resource from BookStack. It contains all the properties returned by the BookStack API for that page, including but not limited to:
- Page ID
- Name/title of the page
- HTML content of the page
- Metadata such as creation date, update date, book and chapter associations, etc.
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 configured in the credentials.
- HTTP requests are made to the BookStack REST API endpoints.
Troubleshooting
- Missing or invalid ID: If the ID property is empty or incorrect, the API call will fail. Ensure the correct page ID is provided.
- Authentication errors: If the API key or token is invalid or missing, the request will be unauthorized. Verify credentials configuration.
- Resource not found: If the specified page ID does not exist, the API will return a 404 error. Confirm the ID corresponds to an existing page.
- Network issues: Connectivity problems to the BookStack server will cause request failures. Check network access and base URL correctness.