HaloPSA Complete icon

HaloPSA Complete

Get data from the HaloPSA API

Actions68

Overview

This node integrates with the HaloPSA API to retrieve multiple field information records based on specified filters and limits. It is particularly useful for users who need to fetch metadata about fields used in various parts of the HaloPSA system, such as custom fields, configuration fields, or approval step fields. Practical applications include dynamically populating UI elements with field options, auditing field configurations, or synchronizing field metadata with other systems.

Properties

Name Meaning
Return All Whether to return all matching results or limit the number of returned items.
Limit Maximum number of results to return when "Return All" is false.
Filters Collection of optional filters to narrow down the returned field info records:
- Access Control Level Filter by access control level (numeric).
- Domain Filter by domain string.
- Exclude Ranges Whether to exclude range-type fields (boolean).
- Exclude Table Self Whether to exclude self-referencing table fields (boolean).
- Exclude Tables Whether to exclude table fields entirely (boolean).
- Extra Type Filter by extra type (numeric).
- Field Type Filter by a single field type (numeric).
- Field Type Multiple Filter by multiple field types, provided as a comma-separated string of numeric values.
- Include Categories Whether to include category fields (boolean).
- Include Date Fields Whether to include date fields (boolean).
- Include Jira Fields Whether to include Jira-related fields (boolean).
- Include Remote Fields Whether to include remote fields (boolean).
- Include Values Whether to include field values in the response (boolean).
- Input Type Filter by input type (numeric).
- Is Approval Step Whether the field is an approval step field (boolean).
- Is Config Whether the field is a configuration field (boolean).
- Is Custom Field Setup Whether the field is part of a custom field setup (boolean).
- System ID Filter by system ID (numeric).
- Type ID Filter by type ID (numeric), e.g., 2 indicates client custom fields.

Output

The node outputs JSON data containing an array of field information objects that match the specified filters and limits. Each object typically includes details such as field identifiers, labels, types, and possibly associated values if requested. The output structure allows downstream nodes or workflows to process or display detailed metadata about HaloPSA fields.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to the HaloPSA API.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The node relies on internal routing logic to call the appropriate API endpoints for fetching field information.

Troubleshooting

  • Common Issues:
    • Incorrect or missing API credentials will cause authentication failures.
    • Overly restrictive filters may result in empty responses.
    • Setting "Return All" to false but not specifying a reasonable "Limit" might lead to incomplete data retrieval.
  • Error Messages:
    • Authentication errors typically indicate invalid or expired API keys; reconfigure credentials.
    • API rate limiting or connectivity issues may cause request failures; verify network and API status.
    • Invalid filter values (e.g., non-numeric where numbers are expected) can cause request errors; ensure correct property types.

Links and References

Discussion