Actions68
- Client Actions
- Agent Actions
- Asset Actions
- Field Info Actions
- Invoice Actions
- Site Actions
- Ticket Actions
- Ticket Status Actions
- Ticket Type Actions
- Timesheet Actions
- Timesheet Event Actions
- Webhook Actions
- Webhook Event Actions
Overview
This node interacts with the HaloPSA API to retrieve detailed information about a specific "Field Info" entity by its ID. It is useful in scenarios where you need to fetch metadata or configuration details related to fields within the HaloPSA system, such as custom field definitions or attributes associated with various entities.
Practical examples include:
- Retrieving the definition of a custom field to dynamically build forms or validate data.
- Fetching additional details about a field for reporting or integration purposes.
- Filtering field info based on user or entity context to tailor data processing workflows.
Properties
| Name | Meaning |
|---|---|
| Field Info ID | The unique numeric identifier of the field info record to retrieve. |
| Additional Options | A collection of optional filters and flags: |
| - Entity ID: Numeric filter to specify the related entity ID. | |
| - Get Lookup Values: Boolean flag to indicate whether to retrieve lookup values for the field. | |
| - Include Details: Boolean flag to include extra detailed information about the field. | |
| - Live Custom Fields: String parameter for specifying live custom fields (usage context-specific). | |
| - User ID: Numeric filter to specify the user context for the field info retrieval. |
Output
The node outputs JSON data representing the requested Field Info object from the HaloPSA API. This includes all standard properties of the field info record, potentially enriched with lookup values and additional details if those options are enabled.
If lookup values are requested, the output will contain arrays or objects representing those values linked to the field.
No binary data output is produced by this node.
Dependencies
- Requires an active connection to the HaloPSA API via an API key credential configured in n8n.
- The node depends on the HaloPSA API endpoints for Field Info data retrieval.
- Proper network access and authentication permissions are necessary to successfully call the API.
Troubleshooting
Common Issues:
- Invalid or missing Field Info ID will result in errors or empty responses.
- Insufficient API permissions may cause authorization failures.
- Network connectivity issues can prevent successful API calls.
Error Messages:
- Errors indicating "Not Found" usually mean the specified Field Info ID does not exist.
- Authentication errors suggest problems with the API key or credentials setup.
- Timeout or connection errors imply network or endpoint availability problems.
Resolutions:
- Verify the Field Info ID is correct and exists in the HaloPSA system.
- Ensure the API key credential is valid and has appropriate permissions.
- Check network connectivity and HaloPSA service status.
Links and References
- HaloPSA API Documentation (general reference for API endpoints)
- n8n documentation on creating custom nodes