HAP icon

HAP

Interact with HAP (Hyper Application Platform) API

Actions31

Workflow → Get

AI-generated

Overview

This node interacts with the HAP (Hyper Application Platform) API, specifically focusing on managing workflows when the "Workflow" resource is selected. The "Get" operation under this resource retrieves detailed information about a specific workflow process by its ID.

Typical use cases include:

  • Fetching metadata or configuration details of a particular workflow in an automation system.
  • Integrating workflow data retrieval into larger automation pipelines for monitoring or reporting.
  • Triggering conditional logic based on workflow properties fetched dynamically.

For example, you might use this node to get the status and settings of a workflow before deciding whether to trigger it or update related records.

Properties

Name Meaning
Process ID The ID of the workflow process to retrieve. This is a required string input identifying which workflow's details to fetch.

Output

The node outputs JSON data representing the details of the requested workflow. This typically includes all relevant properties of the workflow such as its configuration, status, triggers, and other metadata as provided by the HAP API.

If the workflow contains any binary data (not indicated here), it would be included in the binary output field; however, this node primarily returns structured JSON data.

Dependencies

  • Requires an API key credential for authenticating with the HAP API.
  • The node expects the HAP API to be accessible and properly configured.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Missing or invalid Process ID: Since the Process ID is required, ensure it is provided and correctly formatted. An empty or incorrect ID will cause the API call to fail.
  • Authentication errors: If the API key credential is missing or invalid, the node will not be able to connect to the HAP API. Verify that the credential is set up correctly.
  • API connectivity issues: Network problems or incorrect API endpoint configurations can lead to failures. Check network access and API availability.
  • Unexpected API responses: If the workflow ID does not exist or the user lacks permissions, the API may return errors. Confirm the workflow exists and the credentials have sufficient rights.

Links and References

Discussion