Hypris icon

Hypris

Interact with the Hypris API

Actions16

Overview

This node interacts with the Hypris API to perform various operations on different resources such as workspaces, databases, items, properties, views, and resource items. Specifically, for the Item resource with the Get Many operation, it retrieves multiple items from a specified database within a workspace.

Typical use cases include:

  • Fetching all or selected fields of items stored in a Hypris database.
  • Integrating item data retrieval into automated workflows for reporting, synchronization, or further processing.
  • Querying items dynamically based on workspace and database selections.

For example, you might use this node to get all published items from a product catalog database to update an e-commerce website or to aggregate data for analytics.

Properties

Name Meaning
Workspace Name or ID The workspace containing the database. Choose from a list or specify an ID using an expression.
Database Name or ID The database to retrieve items from. Choose from a list filtered by the selected workspace or specify an ID using an expression.
Include All Fields Boolean flag indicating whether to include all field values of each item in the response (true) or not (false).

Output

The output is an array of JSON objects representing the retrieved items. Each item object contains fields corresponding to the properties defined in the database. If "Include All Fields" is enabled, all property values for each item are included.

  • The output structure is:
[
  {
    "json": {
      "id": "item-id",
      "property1": "value1",
      "property2": "value2",
      ...
    }
  },
  ...
]
  • No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the Hypris API, including base URL, username, and password.
  • The node uses HTTP Basic Authentication to communicate with the Hypris API endpoints.
  • The node depends on n8n's HTTP request helper to make API calls.
  • Dynamic options (workspaces, databases) are loaded via API calls requiring these credentials.

Troubleshooting

  • Common issues:

    • Failure to load workspace or database options due to invalid or missing credentials.
    • Network errors or incorrect base URL configuration.
    • Insufficient permissions for the API user to access requested resources.
    • Empty results if the database has no items or filters exclude all items.

  • Error messages:

    • "Failed to load databases: <error message>" indicates problems fetching databases; verify workspace selection and credentials.
    • "Error loading properties for items:" suggests issues retrieving database properties; check API access rights.
    • General HTTP errors may occur if the API endpoint is unreachable or authentication fails.

  • Resolutions:

    • Ensure that the API credentials are correctly configured and have necessary permissions.
    • Verify network connectivity and correct API base URL.
    • Confirm that the workspace and database IDs are valid and accessible.
    • Enable "Continue On Fail" in the node settings to handle partial failures gracefully.

Links and References

Discussion