Hypris icon

Hypris

Interact with the Hypris API

Actions16

Overview

This node integrates with the Hypris API to perform operations on various resources such as databases, items, properties, views, workspaces, and resource items within a workspace. Specifically for the Database resource with the Default operation (which corresponds to "Get Many" or "getAll" in the code), it allows users to retrieve multiple databases from a specified workspace.

Common scenarios where this node is beneficial include:

  • Automating data retrieval workflows that require fetching database metadata or lists of databases within a workspace.
  • Integrating Hypris-managed databases into broader automation pipelines, e.g., syncing database lists with other systems.
  • Building dashboards or reports that need up-to-date information about available databases.

Practical example:

  • A user wants to list all databases in a particular workspace to process or analyze their contents further downstream in an n8n workflow.

Properties

Name Meaning
Workspace Name or ID The workspace to operate on. Choose from the list of available workspaces or specify an ID using an expression. This property is required and determines the scope for the database query.

Note: For the Database resource's "getAll" operation, the only required input property is the workspace identifier.

Output

The node outputs JSON data representing the retrieved databases. The structure of each output item corresponds to the database entities returned by the Hypris API under the specified workspace. Each output item contains fields such as database name, ID, and other metadata as provided by the API.

Output format:

  • An array of JSON objects, each representing a database.
  • Each object includes at least the database's name and unique identifier.
  • The output is delivered as individual items in the n8n workflow, each with a json field containing one database's data.

The node does not output binary data.

Dependencies

  • Requires an active connection to the Hypris API.
  • Needs credentials including base URL, username, and password for authentication.
  • The node uses HTTP Basic Authentication to communicate with the Hypris API.
  • The workspace must exist and be accessible with the provided credentials.
  • The node depends on n8n's credential management to securely store and use the API credentials.

Troubleshooting

Common Issues

  • Invalid or missing workspace ID: If the workspace ID is incorrect or not provided, the node will fail to retrieve databases.
  • Authentication errors: Incorrect API credentials (username/password) will cause authentication failures.
  • Network issues: Connectivity problems to the Hypris API endpoint can cause request timeouts or failures.
  • API permission errors: The authenticated user may lack permissions to access the workspace or its databases.

Common Error Messages and Resolutions

  • "Failed to load databases: <error message>": Indicates failure during the API call to fetch databases. Check network connectivity, credentials, and workspace ID validity.
  • "Error loading databases:" logged internally: Review the error details in the n8n execution logs to diagnose issues.
  • Authentication errors typically manifest as 401 Unauthorized responses; verify credentials and API access rights.
  • If no databases are returned, confirm that the workspace contains databases and that the user has access.

Links and References


This summary focuses on the Database resource with the default "getAll" operation as requested, based on static analysis of the provided source code and property definitions.

Discussion