HAP icon

HAP

Interact with HAP (Hyper Application Platform) API

Actions31

Worksheet → Update

AI-generated

Overview

This node interacts with the Hyper Application Platform (HAP) API to update the configuration of an existing worksheet. It allows users to modify worksheet metadata such as its name, alias, and section grouping, as well as manage the fields within the worksheet by adding new fields, editing existing ones, or removing fields.

Common scenarios where this node is beneficial include:

  • Renaming a worksheet or changing its identifier to better reflect updated business requirements.
  • Reorganizing worksheets by moving them between different sections or groups.
  • Dynamically updating the structure of a worksheet by adding new data fields, modifying existing field properties, or cleaning up obsolete fields.

Practical example:

  • A user wants to rename a worksheet from "Customer Data" to "Client Data", add a new required field for "Phone Number", edit the label of an existing field, and remove deprecated fields all in one operation.

Properties

Name Meaning
Worksheet ID The unique identifier of the worksheet to update (required).
Worksheet Name The new name to assign to the worksheet.
Alias The new alias or identifier string for the worksheet.
Section ID The ID of the group or section to which the worksheet should be assigned.
Add Fields JSON array describing new fields to add. Each object includes properties like name, type, and whether the field is required. Example: [{"name": "New Field", "type": 2, "required": true}]
Edit Fields JSON array describing existing fields to edit. Each object must include the field ID and any properties to update. Example: [{"ID": "field_id", "name": "Updated Field Name"}]
Remove Fields JSON array of field IDs to remove from the worksheet. Example: ["field_id_1", "field_id_2"]

Output

The node outputs JSON data representing the updated worksheet configuration returned by the HAP API after the update operation completes successfully. This typically includes the worksheet's current metadata and field definitions reflecting the applied changes.

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

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 service.

Troubleshooting

  • Invalid Worksheet ID: If the provided worksheet ID does not exist or is malformed, the API will likely return an error indicating the worksheet was not found. Verify the worksheet ID before running the node.
  • Malformed JSON in Fields: The Add Fields, Edit Fields, and Remove Fields inputs expect valid JSON arrays. Invalid JSON syntax or incorrect field structures will cause errors. Use proper JSON formatting and ensure required properties like field IDs are included when editing.
  • Permission Errors: Insufficient permissions or invalid API credentials can result in authorization errors. Ensure the API key has rights to update worksheets.
  • API Rate Limits or Network Issues: Temporary failures may occur due to network problems or API rate limiting. Retrying after some time or checking connectivity may resolve these issues.

Links and References

Discussion