Actions31
- Option Set Actions
- Public Query Actions
- Record Actions
- Role Actions
- Workflow Actions
- Worksheet Actions
Worksheet → Create
AI-generatedOverview
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 structured worksheets to your HAP environment, enabling automated data organization and management.
Typical use cases include:
- Automating the setup of new worksheets as part of onboarding or project initialization.
- Dynamically creating worksheets based on external triggers or data inputs.
- Defining custom fields and configurations for worksheets without manual intervention.
For example, you might use this node to create a worksheet named "Project Tasks" with specific fields like "Task Name", "Due Date", and "Status" in a particular section of your application.
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 created. |
| Fields | A JSON array defining the fields of the worksheet. Each field object includes properties such as 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 identifiers, configuration, and metadata about the worksheet and 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 context, the output is JSON only.
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 access.
Troubleshooting
- Authentication errors: Ensure that the API key credential is correctly set up and has sufficient permissions to create worksheets.
- Invalid input data: The
fieldsproperty must be a valid JSON array with correctly structured field objects. Malformed JSON or missing required properties may cause errors. - Section ID issues: Providing an incorrect or non-existent Section ID may result in failure to create the worksheet. Verify the Section ID before execution.
- API connectivity problems: Network issues or incorrect API endpoint configuration can prevent successful communication with the HAP API.
Common error messages might include authentication failures, validation errors for input fields, or HTTP errors indicating resource not found or permission denied. Resolving these usually involves checking credentials, input correctness, and API access rights.
Links and References
- HAP (Hyper Application Platform) Official Documentation (replace with actual URL)
- n8n documentation on Creating Custom Nodes
- JSON Schema guidelines for defining field structures
Note: The above summary is based solely on static analysis of the provided source code and property definitions.