Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Report Repository → List Of Lookup

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve a list of lookup values from the "Report Repository" resource. Specifically, the "List Of Lookup" operation fetches filtered lookup data based on various optional query parameters. This is useful for scenarios where you need to dynamically obtain reference or configuration data related to reports, such as filtering by client, contract, country, or other criteria.

Practical examples include:

  • Fetching all lookup entries relevant to a specific client or contract.
  • Retrieving lookup codes excluding certain categories (e.g., no-charge items).
  • Obtaining hierarchical (tree) structured lookup data if supported.

Properties

Name Meaning
Access Control Level Filter lookups by access control level.
Assettype Id Filter by asset type identifier.
Client Id Filter by client identifier.
Clientname Filter by client name (string).
Contract Id Filter by contract identifier.
Country Code Id Filter by country code identifier.
Dbc Company Id Filter by DBC company identifier (string).
Domain Filter by domain (string).
Exclude Nocharge Option to exclude no-charge items from results.
Exclude Nolinkedtypes Option to exclude items without linked types.
Exclude Zero Option to exclude zero-value entries.
Iscustomfield Filter by whether the field is custom.
Istree Filter by whether the lookup is tree-structured.
Lookupid Filter by specific lookup identifier.
Ordervaluetype Filter by order value type.
Outcome Id Filter by outcome identifier.
Showallcodes Option to show all codes regardless of other filters.
Ticket Id Filter by ticket identifier.
Unameaprestriction Filter by username application restriction.
Use Filter by usage type.
Use 2 Additional usage filter.

All these properties are sent as query parameters in the API request and are optional filters to refine the lookup list returned.

Output

The node outputs an array of JSON objects representing the lookup entries retrieved from the Halo PSA API. Each item corresponds to one lookup record matching the specified filters.

The output structure is:

[
  {
    "json": {
      // Lookup entry fields as returned by the API
    },
    "pairedItem": {
      "item": <index_of_input_item>
    }
  }
]

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node expects credentials providing base URL, tenant ID, client ID, and client secret.
  • Network connectivity to the Halo PSA API endpoint is necessary.

Troubleshooting

  • No credentials returned!
    Ensure that valid API authentication credentials are configured in n8n before executing the node.

  • Resource or Operation not found errors
    Verify that the selected resource is "Report Repository" and operation is "List Of Lookup". These must match exactly.

  • API request failures
    Check network connectivity and validity of query parameter values. Invalid filters may cause the API to return errors.

  • JSON parsing errors
    If using advanced JSON parameters (not typical for this operation), ensure JSON syntax is correct.

  • Empty results
    Try relaxing filters or removing some query parameters to confirm data availability.

Links and References

Discussion