Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Xtype → List Of Xtype

AI-generated

Overview

This node integrates with the Halo PSA API to perform various operations on different resources. Specifically, for the Xtype resource and the List Of Xtype operation, it retrieves a filtered list of "xtype" entities from the Halo PSA system based on provided query parameters.

Typical use cases include:

  • Fetching specific types of assets or tickets filtered by criteria such as asset group, ticket type, or creation/edit permissions.
  • Automating workflows that require dynamic retrieval of xtype data for further processing or decision-making.
  • Integrating Halo PSA xtype data into other systems or dashboards.

For example, you might use this node to get all xtypes related to a particular asset group or only those that can be created or edited, enabling conditional logic in your automation.

Properties

Name Meaning
Assetgroup Id Filter xtypes by a specific asset group identifier.
Can Create Only Filter to include only xtypes that can be created.
Can Edit Only Filter to include only xtypes that can be edited.
Fixedassetgroups Filter xtypes related to fixed asset groups.
Include Current Option to include the current xtype in the results.
Resourcesonly Filter to include only resource-related xtypes.
Setuplist Filter xtypes based on setup list criteria.
Tickettype Id Filter xtypes by a specific ticket type identifier.
Type Filter xtypes by a string representing the type.

All these properties are sent as query parameters to the API request when listing xtypes.

Output

The node outputs an array of JSON objects, each representing an xtype entity returned by the Halo PSA API. The exact structure depends on the API response but typically includes details about each xtype matching the filter criteria.

If the node encounters errors during execution, it outputs JSON objects containing an error field with the error message.

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the Halo PSA API, including base URL, tenant ID, client ID, and client secret.
  • The node uses HTTP requests to communicate with the Halo PSA REST API.
  • Proper configuration of the API credentials in n8n is necessary for successful authentication.

Troubleshooting

  • No credentials returned!
    This error indicates missing or misconfigured API credentials. Ensure that the required API key or authentication token is correctly set up in n8n credentials.

  • Resource or Operation not found
    If the specified resource or operation does not exist, verify that the resource name is exactly "Xtype" and the operation is "List Of Xtype".

  • API request failures
    Network issues, incorrect query parameters, or insufficient permissions may cause API errors. Check the API endpoint URL, query parameters, and credential permissions.

  • JSON parsing errors
    If using advanced JSON parameters, ensure that any JSON strings are well-formed.

Using the "Continue On Fail" option allows the workflow to proceed even if some items fail, returning error messages in the output.

Links and References

Discussion