Hypris icon

Hypris

Interact with the Hypris API

Actions16

Overview

This node interacts with the Hypris API to manage various resources such as workspaces, databases, items, properties, views, and resource items. Specifically, for the Workspace - Create operation, it allows users to create a new workspace by specifying its name. This is useful in scenarios where you want to programmatically organize your data or projects into separate workspaces within Hypris.

Practical examples include:

  • Automating the creation of new project spaces when onboarding new clients.
  • Dynamically generating workspaces based on external triggers or workflows.
  • Integrating workspace management into larger automation pipelines.

Properties

Name Meaning
Workspace Name Name for the new workspace to be created

Output

The node outputs JSON data representing the newly created workspace. The exact structure depends on the Hypris API response but typically includes details such as the workspace ID, name, and other metadata.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Hypris API.
  • Needs network access to the Hypris API endpoint specified in the credentials.
  • Uses HTTP Basic Authentication with username and password from the credentials.
  • The node relies on internal helper methods to build requests and parse responses according to the Hypris API specification.

Troubleshooting

  • Authentication errors: Ensure that the API credentials (username and password) are correctly configured and have sufficient permissions to create workspaces.
  • Validation errors: The "Workspace Name" property is required; leaving it empty will cause the request to fail.
  • API connectivity issues: Verify network connectivity to the Hypris API base URL.
  • Unexpected API errors: Check the error message returned by the API for details; common issues might include rate limits or malformed requests.
  • If the node throws errors related to loading options or properties, ensure that dependent parameters (like workspaceId) are set correctly.

Links and References

Discussion