Hypris icon

Hypris

Interact with the Hypris API

Actions16

Overview

This node interacts with the Hypris API to create a new item within a specified workspace and database. It allows users to define the state of the item (published or draft) and set multiple field values for the item based on properties defined in the target database.

Typical use cases include:

  • Automating the creation of content items or records in a Hypris-managed database.
  • Populating new entries with specific property values programmatically.
  • Managing content lifecycle by setting the item state during creation.

For example, you might use this node to add a new product entry to an inventory database, specifying fields like name, category, and price, and marking it as published immediately.

Properties

Name Meaning
Workspace Name or ID The workspace where the item will be created. Choose from a list of available workspaces or specify an ID using an expression.
Database Name or ID The database within the workspace where the item will be created. Choose from a list filtered by the selected workspace or specify an ID using an expression.
Item State The publication state of the new item. Options: Published or Draft.
Item Fields A collection of fields to set on the new item. Each field requires:
- Property Name or ID: Select a property from the database or specify its ID.
- Value Name or ID: The value to assign to that property. For select fields, choose from dropdown options; for others, type or use expressions.

Output

The node outputs JSON data representing the newly created item as returned by the Hypris API. The structure includes all relevant details of the created item, such as its ID, state, and the values of its properties.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Hypris API.
  • Needs network access to the Hypris API endpoint configured via credentials.
  • Uses dynamic loading of options for workspaces, databases, properties, and property values through API calls.

Troubleshooting

  • Common Issues:

    • Failure to load workspace or database options may indicate incorrect or missing API credentials or network connectivity issues.
    • Errors when specifying property IDs or values often result from mismatches between the selected database and the provided property identifiers.
    • Attempting to create an item without required fields or with invalid values can cause API errors.

  • Error Messages:

    • "Failed to load databases:" — Check that the workspace ID is valid and the API credentials have sufficient permissions.
    • "Error loading properties for items:" — Verify the database ID and ensure the API user has access to read properties.
    • API request errors during creation — Confirm that all required parameters are provided and correctly formatted.

To resolve these issues, verify your API credentials, confirm the workspace and database selections, and ensure that property IDs and values correspond to those defined in the target database.

Links and References

Discussion