BookStackInstall

Overview

This node integrates with the BookStack API to manage various BookStack resources such as books, pages, chapters, shelves, users, roles, attachments, and tags. Specifically for the Role resource with the Copy operation, it allows duplicating an existing role by sending a copy request to the BookStack API.

The node supports two modes of operation:

• Automatic mode: The user provides a natural language description of the desired action (e.g., "copy the role 'Editor'"), and the node attempts to parse this description to determine the resource and operation automatically.
• Manual mode: The user explicitly selects the resource ("Role") and operation ("Copy") and provides required parameters like the ID of the role to copy.

Practical examples

• Copying a role named "Editor" to create a duplicate with the same permissions.
• Automating role duplication by describing the request in natural language, e.g., "copy the role 'Manager'".

This node is beneficial when managing permissions programmatically or automating administrative tasks in BookStack.

Properties

Note: For the Copy operation on the Role resource, the node expects the ID of the role to copy, which is provided via the standard "ID" parameter (not shown in the provided properties snippet but used internally).

Output

The node outputs JSON data representing the response from the BookStack API after performing the copy operation. This typically includes the details of the newly created copied role, such as its ID, name, permissions, and other metadata.

If the operation fails, the output JSON will contain an error message describing the issue.

No binary data output is involved in this operation.

Dependencies

• Requires an API key credential for authenticating with the BookStack API.
• The node uses the base URL and token credentials configured in n8n to communicate with the BookStack API.
• The BookStack API must be accessible from the environment where n8n runs.

Troubleshooting

• Common issues:

  • Providing an invalid or missing role ID will cause the API call to fail.
  • Incorrect or expired API credentials will result in authentication errors.
  • Network connectivity issues can prevent communication with the BookStack API.

• Error messages:

  • Errors returned from the BookStack API are passed through in the output JSON under an error field.
  • If the node is set to continue on failure, errors will not stop execution but will be included in the output for inspection.

• Resolutions:

  • Verify that the role ID exists and is correct.
  • Check and update API credentials if authentication fails.
  • Ensure network access to the BookStack API endpoint.

Links and References

• BookStack Official API Documentation
• n8n Documentation on Creating Custom Nodes