HaloPSA Complete icon

HaloPSA Complete

Get data from the HaloPSA API

Overview

This node integrates with the HaloPSA API to retrieve detailed information about assets by their unique ID. It is designed to fetch a specific asset's data, optionally including related details such as activity logs, allowed statuses, diagrams, hierarchy, and other extended information.

Common scenarios where this node is beneficial include:

  • Retrieving comprehensive asset details for IT service management or inventory tracking.
  • Fetching asset-related activity history or status options for reporting or auditing.
  • Accessing hierarchical or diagrammatic representations of assets for visualization or analysis.

Practical example:

  • An IT administrator wants to get full details of a server asset, including its maintenance activity and allowed status transitions, to prepare for an upgrade.

Properties

Name Meaning
Asset ID The unique numeric identifier of the asset to retrieve.
Additional Options A collection of optional filters and flags to customize the response:
- Asset Type ID Numeric filter to specify the type of asset.
- Include Activity Boolean flag to include activity details related to the asset in the response.
- Include Allowed Status Boolean flag to include allowed status details for the asset.
- Include Details Boolean flag to include extra related objects/details in the response.
- Include Diagram Details Boolean flag to include diagrammatic details of the asset.
- Include Hierarchy Boolean flag to include hierarchical information related to the asset.

Output

The node outputs JSON data representing the requested asset and any additional details based on the selected options. The structure typically includes:

  • Core asset properties (ID, name, type, etc.).
  • Optional nested objects or arrays for activity logs, allowed statuses, diagrams, hierarchy, and other extended details if requested.

If binary data were involved (not indicated here), it would represent files or images related to the asset, but this node focuses on JSON data only.

Dependencies

  • Requires connection to the HaloPSA API via an API key credential configured in n8n.
  • The node depends on the HaloPSA API endpoints to fetch asset data.
  • No additional external services are required beyond the HaloPSA API.

Troubleshooting

  • Common issues:

    • Invalid or missing Asset ID will cause the request to fail or return no data.
    • Insufficient API permissions may result in authorization errors.
    • Network connectivity problems can prevent successful API calls.
    • Requesting unsupported or invalid additional options might lead to incomplete or error responses.
  • Error messages and resolutions:

    • "Asset not found": Verify the Asset ID is correct and exists in HaloPSA.
    • "Unauthorized" or "Authentication failed": Check that the API key credential is valid and has necessary permissions.
    • "Request timeout" or network errors: Ensure stable internet connection and HaloPSA API availability.
    • Unexpected response format: Confirm that the API version matches the node expectations and that options used are supported.

Links and References

Discussion