Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Integration Field Mapping → List Of Integration Field Mapping

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve a list of integration field mappings. It is designed to query and fetch mapping configurations that define how fields are integrated between systems within the Halo PSA environment.

Common scenarios where this node is beneficial include:

  • Synchronizing or auditing integration field mappings between Halo PSA and other platforms.
  • Automating retrieval of current field mapping configurations for reporting or further processing.
  • Using the retrieved mappings as input for subsequent workflow steps, such as data transformation or validation.

For example, a user might use this node to fetch all integration field mappings filtered by specific criteria like product ID or type ID, then process or export these mappings elsewhere.

Properties

Name Meaning
Msid A string filter parameter to specify the MSID (likely an identifier related to the mapping).
Product Id Filter by product identifier to narrow down the integration field mappings.
Subtypeid A string filter parameter to specify subtype ID for filtering the mappings.
Syncfields Filter parameter to specify which fields should be synchronized or included.
Typeid A string filter parameter to specify type ID for filtering the mappings.
Xmvalue A string filter parameter, possibly representing an XML value or similar, for filtering.

All these properties are sent as query parameters in the API request to filter the list of integration field mappings returned by the Halo PSA API.

Output

The node outputs JSON data containing the list of integration field mappings retrieved from the Halo PSA API. Each item in the output corresponds to one integration field mapping object as returned by the API.

The structure of each JSON object depends on the API response but typically includes details about the mapping configuration such as IDs, field names, types, and synchronization settings.

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the Halo PSA API, including base URL, tenant identifier, client ID, and client secret.
  • The node uses these credentials to authenticate API requests via custom headers.
  • No additional external dependencies beyond the Halo PSA API and n8n's HTTP request capabilities.

Troubleshooting

  • No credentials returned!
    This error occurs if the node cannot find or access the required API credentials. Ensure that the API key credential is properly configured in n8n and assigned to the node.

  • Resource or Operation not found
    If the specified resource or operation does not exist, verify that the correct resource ("Integration Field Mapping") and operation ("List Of Integration Field Mapping") are selected.

  • API request errors
    Errors from the Halo PSA API (e.g., authentication failures, invalid query parameters) will be returned in the node output if "Continue On Fail" is enabled; otherwise, they will stop execution. Check the API credentials and query parameters for correctness.

  • Invalid JSON in parameters
    If using JSON parameters for query or body, ensure the JSON syntax is valid to avoid parsing errors.

Links and References

(Note: Replace placeholder links with actual URLs relevant to Halo PSA API if available.)

Discussion