HAP icon

HAP

Interact with HAP (Hyper Application Platform) API

Actions31

Overview

This node interacts with the HAP (Hyper Application Platform) API to create a new worksheet within a specified section or group. It is useful when you want to programmatically define and add worksheets that organize data fields in your HAP environment. Typical use cases include automating the setup of new worksheets for data collection, reporting, or workflow management.

For example, you might use this node to create a worksheet named "Project Tasks" with custom fields such as task name, due date, and status, grouped under a specific project section.

Properties

Name Meaning
Worksheet Name The name of the worksheet to be created.
Alias An optional alias or identifier for the worksheet.
Section ID The ID of the group or section under which the worksheet will be organized.
Fields A JSON array defining the fields to create in the worksheet. Each field object includes properties like name, type, whether it is required, and if it serves as the title field. Example: [{"name": "Field Name", "type": 2, "required": true, "isTitle": true}]

Output

The node outputs JSON data representing the newly created worksheet's details as returned by the HAP API. This typically includes the worksheet's unique identifier, name, alias, section ID, and the configuration of its fields.

If the node supports binary data output, it would represent any associated files or attachments related to the worksheet creation, but based on the provided code and properties, the primary output is JSON structured data about the worksheet.

Dependencies

  • Requires an API key credential for authenticating with the HAP API.
  • The node expects the HAP API endpoint to be accessible and properly configured.
  • No additional external dependencies are indicated beyond the HAP API and its authentication.

Troubleshooting

  • Authentication errors: Ensure the API key credential is correctly set up and has sufficient permissions to create worksheets.
  • Invalid field definitions: The fields property must be a valid JSON array with correctly structured field objects. Malformed JSON or missing required field attributes may cause errors.
  • Section ID issues: Providing an incorrect or non-existent section ID may result in failure to create the worksheet or placing it in an unintended location.
  • API connectivity problems: Network issues or incorrect API endpoint configurations can prevent successful communication with the HAP API.

Common error messages might include authorization failures, validation errors on the input fields, or server errors from the API. To resolve these, verify credentials, validate input JSON, and check network/API availability.

Links and References

Discussion