Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Audit → Get One Audit

AI-generated

Overview

This node interacts with the Halo PSA API to retrieve detailed information about a specific audit record. It is designed to fetch one audit entry by its unique identifier, optionally including additional details related to that audit.

Common scenarios for this node include:

  • Retrieving audit logs for compliance or security reviews.
  • Fetching detailed change history for troubleshooting or analysis.
  • Integrating audit data into workflows for reporting or alerting purposes.

For example, a user might use this node to get an audit record by its ID and include detailed information about changes made during that audit event.

Properties

Name Meaning
Id The unique numeric identifier of the audit record to retrieve.
Includedetails Optional flag or parameter to specify whether to include detailed information in output.

Output

The node outputs JSON data representing the audit record retrieved from the Halo PSA API. This includes all standard fields of the audit entry, and if requested, additional detailed information related to the audit.

The output structure corresponds directly to the API response for a single audit, typically containing fields such as audit metadata, timestamps, user information, and any associated changes or notes.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • Needs configuration of the base URL, tenant identifier, client ID, and client secret for the Halo PSA service.
  • Relies on network connectivity to the Halo PSA API endpoint.

Troubleshooting

  • Missing Credentials: If no credentials are provided or they are invalid, the node will throw an error indicating "No credentials returned!" Ensure that valid API authentication details are configured.
  • Invalid Resource or Operation: Errors like "Resource Audit not found" or "Operation Get One Audit not found for resource Audit" indicate misconfiguration of parameters. Verify that the resource and operation names are correct.
  • Invalid Id Parameter: Providing a non-numeric or missing Id will cause the request to fail. Make sure the Id is a valid number corresponding to an existing audit record.
  • API Request Failures: Network issues, incorrect tenant/client credentials, or insufficient permissions can cause API request errors. Check the error message returned and verify API access rights and connectivity.
  • JSON Parsing Errors: If additional query parameters or request bodies are malformed JSON, the node may throw parsing errors. Validate JSON inputs carefully.

Links and References

Discussion