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 databases, items, properties, resource items, views, and workspaces. Specifically, for the Resource Item resource with the Get Many operation, it retrieves multiple resource items within a specified workspace.

Common scenarios where this node is beneficial include:

  • Fetching all resource items from a particular workspace to process or analyze them in workflows.
  • Integrating Hypris data into other systems by extracting bulk resource item information.
  • Automating reporting or synchronization tasks that require listing resource items.

For example, you might use this node to get all resource items in a workspace before filtering or updating them in subsequent workflow steps.

Properties

Name Meaning
Workspace Name or ID The workspace to operate on. Choose from a dropdown list of available workspaces or specify an ID using an expression. This property is required to identify which workspace's resource items to retrieve.

Output

The node outputs JSON data representing the retrieved resource items. The structure corresponds to the resource items returned by the Hypris API for the given workspace. Each output item contains the full details of a resource item as provided by the API.

If multiple resource items are returned, each will be output as a separate JSON object in the array of results.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Hypris API.
  • Needs network access to the Hypris API endpoint.
  • The node uses HTTP Basic Authentication with username and password credentials.
  • The workspace list is dynamically loaded via an API call to populate the "Workspace Name or ID" dropdown.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Specifying an incorrect or non-existent workspace ID will result in empty results or errors.
    • Network connectivity problems can prevent API requests from succeeding.

  • Error messages:

    • Errors during API requests (e.g., failed to load workspaces or resource items) will be logged and may throw exceptions.
    • If the node is set to continue on failure, errors will be returned as JSON objects with an error field describing the issue.

  • Resolutions:

    • Verify that the API credentials are correctly configured and have sufficient permissions.
    • Ensure the workspace ID is valid and accessible.
    • Check network connectivity and API endpoint availability.

Links and References

Discussion