Actions31
- Option Set Actions
- Public Query Actions
- Record Actions
- Role Actions
- Workflow Actions
- Worksheet Actions
Public Query → Get Region
AI-generatedOverview
This node interacts with the HAP (Hyper Application Platform) API to retrieve region information via its "Public Query" resource and the "Get Region" operation. It allows users to fetch details about a specific region or search for regions by name. This is useful in scenarios where workflows need to dynamically obtain geographic or organizational region data, such as populating dropdowns, filtering data based on location, or integrating with systems that require regional context.
Practical examples include:
- Fetching sub-regions of a given region ID to build hierarchical location selectors.
- Searching for regions matching a user-provided term to enable autocomplete or search features in applications.
Properties
| Name | Meaning |
|---|---|
| Region ID | The identifier of the region for which to retrieve sub-region information. |
| Search | A search term string used to find regions whose names match or contain this term. |
Output
The node outputs JSON data containing the region information retrieved from the HAP API. This typically includes details about the specified region or a list of regions matching the search criteria. The exact structure depends on the API response but generally contains region identifiers, names, and possibly hierarchical relationships.
No binary data output is produced by this node.
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 beyond the HAP API and its authentication are needed.
Troubleshooting
Common issues:
- Invalid or missing Region ID may result in empty or error responses.
- Network connectivity problems can cause request failures.
- Insufficient permissions or invalid API credentials will lead to authentication errors.
Error messages:
- Authentication errors indicate issues with the provided API key; verify and update credentials.
- "Region not found" or similar messages suggest the Region ID does not exist; check the input value.
- Timeout or network errors require checking internet connection and API availability.
Links and References
- HAP (Hyper Application Platform) API Documentation (Replace with actual URL if available)