Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Projects → Get One Faults

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve detailed information about a specific fault within a project. The "Get One Faults" operation under the "Projects" resource fetches data for a single fault identified by its ID, optionally including various related details such as auditing info, linked objects, appointments, and more.

Typical use cases include:

  • Fetching comprehensive fault details for project management or issue tracking.
  • Integrating fault data into workflows for automated reporting or notifications.
  • Enriching fault records with additional context like assigned agents, audit trails, or related tickets.

For example, a user might automate the retrieval of fault details when a new fault is logged, then trigger follow-up actions based on the fault's status or assigned team.

Properties

Name Meaning
Id The unique numeric identifier of the fault to retrieve (required).
Amailentryid Filter or query parameter for mail entry ID associated with the fault.
Assignedto Filter for faults assigned to a specific user or team.
Consignablelines Query parameter related to consignable lines (specific meaning depends on API context).
Debug Boolean flag to include debug information in the response.
Dodatabaselookup Query parameter to enable database lookup (specific meaning depends on API context).
Email Filter faults by associated email address.
Include Auditing Boolean flag to include auditing information in the response.
Includeagent Flag to include agent details related to the fault.
Includechildids Flag to include child IDs related to the fault.
Includedetails Boolean flag to include extra objects/details in the response.
Includelastaction Flag to include the last action performed on the fault.
Includelastappointment Boolean flag to include the last appointment related to the fault.
Includelinkedobjects Boolean flag to include linked objects in the response.
Includenextappointment Boolean flag to include the next appointment related to the fault.
Includeparentchangeinfo Flag to include change info from parent objects.
Includeparentsubject Flag to include the subject of the parent object.
Includeseenby Flag to include information about who has seen the fault.
Is Portal Flag indicating if the request is from a portal context.
Isdetailscreen Flag indicating if the request is for a detail screen view.
Ishalolink Flag related to Halo link integration (specific meaning depends on API context).
Ispreview Flag indicating if the request is a preview.
Isteams Boolean flag to return only team-related tickets in the response.
Nocache Boolean flag to disable caching of the response.
Subject Filter faults by subject text.
Ticketidonly Boolean flag to include only details related to the specified ticket.
Utcoffset Timezone offset value for date/time fields in the response.

Output

The node outputs an array of JSON objects, each representing the response from the Halo PSA API for the requested fault. The JSON structure contains detailed fault information, potentially enriched with optional data depending on the input flags (e.g., auditing, linked objects, appointments).

If binary data were involved (not applicable here), it would be included separately, but this operation deals solely with JSON data.

Example output snippet (conceptual):

{
  "faultId": 123,
  "subject": "Example fault",
  "assignedTo": "User Name",
  "auditing": { ... },
  "linkedObjects": [ ... ],
  "lastAppointment": { ... },
  ...
}

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node uses the base URL, tenant ID, client ID, and client secret from the credentials to construct requests.
  • No additional external dependencies beyond the configured Halo PSA API access.

Troubleshooting

  • No credentials returned!: Ensure that valid API credentials are configured in n8n for the Halo PSA service.
  • Resource or Operation not found: Verify that the selected resource is "Projects" and operation is "Get One Faults".
  • Invalid or missing Id: The "Id" property is required; ensure it is provided and is a valid number.
  • API errors: If the API returns errors, check network connectivity, API permissions, and that the requested fault ID exists.
  • JSON parsing errors: When using JSON parameters, ensure they are correctly formatted.
  • Enable "Continue On Fail" in the node settings to handle errors gracefully during batch executions.

Links and References

Discussion