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 Chapter - Get operation, it retrieves detailed information about a single chapter by its ID.
Common scenarios where this node is beneficial include:
- Fetching chapter details to display or process in workflows.
- Automating documentation retrieval from BookStack.
- Integrating BookStack content into other systems or reports.
Practical example:
- You want to get metadata and content of a specific chapter in your BookStack instance by providing its unique ID, then use that data downstream in your automation.
Properties
| Name | Meaning |
|---|---|
| Tool Description | Choose how to determine the resource and operation: "Set Automatically" or "Set Manually" |
| Request Description | (Shown if "Set Automatically") Describe what you want to do in natural language; the system tries to infer resource and operation automatically |
| ID | The unique identifier of the chapter resource to retrieve (required for Get operation) |
Output
The output is a JSON object representing the retrieved chapter resource from BookStack. It contains all standard fields returned by the BookStack API for a chapter, such as its ID, name, description, book association, creation date, update date, and any other metadata provided by the API.
No binary data output is produced by this operation.
Example output structure (simplified):
{
"id": 123,
"name": "Chapter Title",
"description": "Description of the chapter",
"book_id": 45,
"created_at": "2023-01-01T12:00:00Z",
"updated_at": "2023-01-02T12:00:00Z",
...
}
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 to be configured in the credentials.
- HTTP requests are made to the BookStack REST API endpoints.
Troubleshooting
- Missing or invalid ID: The "ID" property is required for the Get operation. Ensure you provide a valid chapter ID; otherwise, the API will return an error.
- Authentication errors: Verify that the API token and base URL credentials are correctly set up and have sufficient permissions.
- Resource not found: If the chapter ID does not exist, the API will return a 404 error. Confirm the ID is correct.
- Automatic detection issues: When using "Set Automatically" mode with a request description, ambiguous or unclear descriptions may lead to incorrect resource or operation detection. Use manual mode if automatic detection fails.